PhUI - API¶
Implementa interface gráfica através da combinação de componentes (codificados em Java Script Lite), estilos baseados em CSS (Cascading Style Sheets) e imagens/fontes armazenadas no dispositivo e referenciadas no arquivo Json que contém esses estilos.
Componentes são trechos de script que codificam o comportamento do objeto e sua interligação hierárquica com outros componentes. Esses códigos interpretam o estilo do componente e o renderiza na tela. Codifica as respostas a eventos como toque na tela, teclas pressionadas etc.
Os estilos referenciam a característica visual, o posicionamento do componente e códigos de resposta a alguns eventos. São armazenados em arquivo ascii utilizando uma estrutura de dados JSON (Java Script Object Notation) e organizados seguindo um padrão CSS modificado.
As imagens e fontes que definem o visual propriamente dito, são armazenados no dispositivo e referenciados, através do seu nome físico, no arquivo de estilos que por sua vez é interpretado no script gerenciador do componente em si.
Essas são as três partes fundamentais da API gráfica baseada em componentes, do Java Script Lite.
Para maiores detalhes consulte a suite de exemplos disponibilizada junto com o SDK.
Sumário das urls utilizadas na API¶
Módulo url Anim package://phui#components/anim.wmlsc Boolean package://phui#components/boolean.wmlsc Button package://phui#components/button.wmlsc Component package://phui#components/components.wmlsc Events package://phui#components/events.wmlsc Field package://phui#components/field.wmlsc Frame package://phui#components/frame.wmlsc Grid package://phui#components/grid.wmlsc Hotkey package://phui#components/hotkey.wmlsc Image package://phui#components/image.wmlsc Info package://phui#input/info.wmls Info Components package://phui#components/info.wmlsc InputUI package://phui#input/input.wmlsc Keyboard package://phui#components/keyboard.wmlsc Label package://phui#components/label.wmlsc Memo package://phui#components/memo.wmlsc Menu package://tefui#ui/menu.wmlsc Menu Components package://phui#components/menu.wmlsc Navigation package://phui#components/navigation.wmlsc Paged_menu package://phui#components/paged_menu.wmlsc Progress package://phui#components/progress.wmlsc Scroll package://phui#components/scroll.wmlsc Status package://phui#components/status.wmlsc Style package://phui#components/style.wmlsc Timer package://phui#components/timer.wmlsc Tbitmap package://libs#ui/tbitmap.wmlsc
Anim¶
| package://phui#components/anim.wmlsc |
|---|
Componente que fornece suporte a animações de imagens
create¶
Anim#create(fname, styleName)
Cria um novo anim
Parâmetros¶
- cname - Nome do componente (referencia no json abaixo da classe raiz "animation")
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o anim criado.
Exemplo¶
use url Anim "package://phui#components/anim.wmlsc"; var anim = Anim#create("Processing", invalid);Resultado¶
paint¶
Anim#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
onTimer¶
Anim#onTimer(frame, component)
Adiciona um tempo que o frame deve esperar de ociosidade para que seja fechado.
Parâmetros¶
- frame - frame alvo
- component - componente que ira aguardar o tempo.
Retorno¶
Nenhum
Boolean¶
| package://phui#components/boolean.wmlsc |
|---|
Componente que apresenta interface de confirmação em tela. Sendo utilizado exclusivamente no terminal modelo D200.
Sumário¶
Função Descrição create implementa interface de confirmação. paint desenha interface de confirmação. onKey detecta a tecla que foi selecionada: ENTER ou ESC.
Create¶
Boolean#create(fname, msgTrue, msgFalse, defaultValue, styleName)
Prepara uma interface de confirmação.
Parâmetros¶
- fname - string - nome do componente no arquivo de estilo .jcss;
- msgTrue - string - com a mensagem de confirmação;
- msgFalse - string - com a mensagem de confirmação;
- defaultValue - boolean - define qual componente vai receber o foco ;
- styleName - string - com o nome do arquivo de estilo ou invalid;
Retorno¶
Retorna o componente criado.
Paint¶
Boolean#paint(frame, component)
Apresenta uma interface de confirmação.
Parâmetros¶
- frame - string - instância de Frame#create;
- component - string - instância de Boolean#create;
Retorno¶
Retorna o componente criado.
onkey¶
Boolean#onKey(frame, component, key)
Evento que detecta a tecla que foi selecionada no caso ENTER ou ESC.
Parâmetros¶
- frame - string - instância de Frame#create;
- component - string - instância de Boolean#create;
- key - constant - sendo PhKeyBoard.KEY_ENTER ou PhKeyBoard.KEY_ESC;
Retorno¶
Retorna o componente criado.
Exemplo:¶
use url Frame "package://phui#components/frame.wmlsc"; use url Events "package://phui#components/events.wmlsc"; use url Boolean "package://phui#components/boolean.wmlsc"; use url Component "package://phui#components/components.wmlsc"; extern function test() { var module = "package://samplesui/sampleui_buttons.wmlsc"; var comp = Boolean#create("boolean", "sim", "não", 0, "estilo.jcss"); var key = Events#create("key", module, "onKey", invalid); var frame = Frame#create("memo", ""); var controle = true; Component#addEventHandler(comp, key); Frame#add(frame, Label#create("footerBoolean", "lb", "estilo.jcss")); Frame#add(frame, comp); while (controle) { Frame#show(frame); var keyPress = Frame#getResultCode(frame); var keyi = Boolean#onKey(frame, comp, key); if(keyPress == 13) { Dialogs.alert("Uma tecla foi pressionada: "+keyi); Dialogs.alert("Pressionou a tecla ENTER."); controle = false; } else if (keyPress == 27) { Dialogs.alert("Uma tecla foi pressionada: "+keyi); Dialogs.alert("Pressionou a tecla ESC."); controle = false; } } }Exemplo de saída em tela:
Uma tecla foi pressionada : true Pressionou ENTER
Button¶
| package://phui#components/button.wmlsc |
|---|
Componente que fornece suporte a criação de botões
Função Descrição create Cria um novo button. createExt Cria um novo button. getText Obtém o conteúdo da propriedade text do componente. setImgName Atribui o nome da imagem do botão. setLabelAlign Atribui o alinhamento do texto no botão. setText Atribui uma string a propriedade text do componente.
create¶
Button#create(fname, attrs, styleName)
Cria um novo button
Parâmetros¶
- fname - Nome do componente (referencia no json abaixo da classe raiz "button")
- attrs - Lista de atributos ou string contendo o caption do botão. Se for passada uma lista, o primeiro ítem deverá ser o caption do botão e o segundo, o código da tecla que será mapeada com o toque no botão.
- styleName - Nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o botão criado.
Exemplo¶
use url Button "package://phui#components/button.wmlsc"; var bt1 = Button#create("botao1", "Botão 1", invalid);Resultado¶
createExt¶
Button#createExt(fname, attrs, styleName)
Parâmetros¶
- fname - String identificador do botão definido no arquivo de Style.
- attrs - Texto do botão;
- styleName - Nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Botão é criado na tela
Exemplo¶
use url Frame "package://phui#components/frame.wmlsc"; use url Button "package://phui#components/button.wmlsc"; var frame = Frame#create("idle", invalid); var bt1 = Button#createExt("bt1", "My Button", "layout.jcss"); Frame#add(frame, bt1); Frame#show(frame);
getText¶
Button#getText(component)
Obtém o conteúdo da propriedade text do componente.
Parâmetros¶
component - Instância de Button#create
Retorno¶
Obtem o texto atual do botão
Exemplo¶
use url Button "package://phui#components/button.wmlsc"; use url Component "package://phui#components/components.wmlsc"; use url Events "package://phui#components/events.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; var frame = Frame#create("idle", invalid); var bt1 = Button#create("bt1", "Hello", "layout.jcss"); var module = "package://myapplication/myfile.wmlsc"; var key = Events#create("key", module, "onKey", invalid); Component#addEventHandler(bt1, key); Component#setFocusable(bt1, true); Frame#add(frame, Status#create(Style#STATUS(), invalid)); Frame#add(frame, bt1); Frame#show(frame); var keyPress = Frame#getResultCode(frame); if(keyPress == 130) { Dialogs.alert("Botão " + Button#getText(bt1) + " foi clicado"); }
setImgName¶
Button#setImgName(component, img)
atribui o nome da imagem do botão.
Parâmetros¶
- component - componente alvo.
- img - nome da imagem do botão.
Retorno¶
Nenhum
setLabelAlign¶
Button#setLabelAlign(component, align)
atribui o alinhamento do texto no botão.
Parâmetros¶
- component - componente alvo;
- align - alinhamento do texto, os valores são representados por constantes do pacote Display (package://libs#ui/display.wmlsc) são eles:
- FG_ALIGN_RIGHT() - alinha o texto a direita:
- FG_ALIGN_LEFT() - alinha o texto a esquerda:
- FG_ALIGN_TOP() - alinha o texto ao topo:
- FG_ALIGN_BOTTOM() - alinha o texto abaixo:
- FG_ALIGN_CENTER() - alinha o texto ao centro:
- FG_ALIGN_VERT() - alinha o texto na vertical:
Retorno¶
Nenhum
setText¶
Button#setText(label, text)
Atribui uma string a propriedade text do componente.
Parâmetros¶
- label - Instância do Button#create;
- text - texto atribuido;
Retorno¶
O texto do botão é alterado
Exemplo¶
use url Button "package://phui#components/button.wmlsc"; use url Component "package://phui#components/components.wmlsc"; use url Events "package://phui#components/events.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; var frame = Frame#create("idle", invalid); var bt1 = Button#create("bt1", "Hello", "layout.jcss"); Frame#add(frame, bt1); Frame#show(frame); var keyPress = Frame#getResultCode(frame); if(keyPress == 130) { Button#setText(bt1, "World!"); }
Component¶
| package://phui#components/components.wmlsc |
|---|
Classe para criação de novos componentes #### Sumário
Função Descrição create cria um novo componente loadProperties carrega o layout definido em um arquivo .jcss para as propriedades do componente. getName obtém o nome do componente getType obtém o tipo do componente getCustom obtém o custom do componente setCustom atribui o custom no componente getModule obtém o módulo do componente getBounds obtém uma lista com os atributos (x, y, w, h) do componente contains verifica se o componente está contigo no frame, baseado nas propriedades x, y, w e h. draw pinta o componente no frame getEventHandler obtém o handler do um evento no componente clearEventHandler remove todos os eventos do componente removeEventHandler remove o evento do componente addEventHandler adiciona um evento no componente isFocusable varifica se o componente permite foco setFocusable atribui ao componente a possibilidade de foco setFocus atribui ao componente a foco isFocused valida se o componente esta focado. isEnable verifica se o componente está habilitado setEnable habilita o componente getProperties obtém as propriedades do componente getPropertiesCustomLoaded obtém as propriedades da custom carregada no componente getStyleName atribui as propriedades da custom carregada no componente setStyleName atribui as propriedades da custom carregada no componente getModified verifica se o componente precisa ser desenhado. setModified atribui um booleano indicando se o componente precisa ser desenhado. getBackgroundEnabled verifica se o background do componente está habilitado. setBackgroundEnabled atribui um booleano indicando se o background componente está habilitado ou não. hasSubComponents verifica se o componente é um subcomponente setHasSubComponents atribui um booleano indicando se o componente é um subcomponente ou não. isPaginator verifica se o componente é um paginador. setPaginator atribui um booleano indicando se o componente é um paginador ou não. getText obter o texto do componente. setText atribui um texto ao componente. drawBackgroundFromStyle2 desenha fundo do componente drawBackgroundFromStyle desenha fundo do componente drawBackgroundFromProperties desenha fundo do componente baseado nas propriedades passadas. getY obtém a coordenada Y do componente getX obtém a coordenada X do componente getW obtém a width do componente getH obtém a height do componente setY atribui a coordenada X ao componente setX atribui a coordenada Y ao componente setW atribui o width ao componente setH atribui o height ao componente getCenterX obtém a posição central da coordenada X getCenterY obtém a posição central da coordenada Y getFontName obtém o nome da fonte do componente getFontColor obtém a cor da fonte do componente getimageName obtém o nome da imagem atribuída ao componente getComponents Obtém todos o subcomponentes de um componente. Atualmente apenas o componente Grid tem subcomponentes.
create¶
Component#create(type, cname, custom, module, styleName)
Cria um novo componente
Parâmetros¶
- type - String - Tipo do componente a ser criado.
- cname - String - Nome do componente.
- custom - PhList - lista com a customização do componente.
- module - String - módulo responsável pelo gerenciamento do componente.
- styleName - String - nome do arquivo jcss, caso não tenha pode ser atribuido invalid ou "".
Retorno¶
Retorna o componente criado.
loadProperties¶
Component#loadProperties(style, component)
Carrega o layout definido em um arquivo .jcss para as propriedades do componente.
Parâmetros¶
- style - String - nome do arquivo .jcss.
- component - Component- Componente alvo.
Retorno¶
Retorna um componente.
getName¶
Component#getName(component)
Obtém o nome do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna uma string.
getType¶
Component#getType(component)
Obtém o tipo do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna o tipo do componente.
getCustom¶
Component#getCustom(component)
Obtém o custom do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna o custom do componente.
setCustom¶
Component#setCustom(component, custom)
Atribui o custom no componente.
Parâmetros¶
component - Component - Componente alvo. custom - Atributos customizados do componente.
Retorno¶
Nenhum
getModule¶
Component#getModule(component)
Obtém o módulo do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
retorna o módulo do componente.
getBounds¶
Component#getBounds(component)
Obtém uma lista com os atributos, x,y, w(width), h(height) do componente.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
retorna uma PhList.
contains¶
Component#contains(frame, component)
Verifica se o componente está contigo no frame, baseado nas propriedades x, y, w e h.
Parâmetros¶
- frame - Frame - Frame que contém o componente.
- component - Component - Componente a ser verificado.
Retorno¶
true ou false.
draw¶
Component#draw(frame, component, force)
Pinta o componente.
Parâmetros¶
- frame - Frane - Frame alvo para adicionar o componente.
- component - Component - Componente a ser desenhado no frame.
- force - Boolean - boleano para forçar ou não o componente a ser redesenhado.
Retorno¶
retorna uma PhList.
getEventHandler¶
Component#getEventHandler(component, event)
Obtém o handler do um evento no componente.
Parâmetros¶
- component - Component - Componente alvo.
- event - Event evento alvo.
Retorno¶
retorna o handler
removeEventHandler¶
Component#removeEventHandler(component, event)
Remove o evento do componente.
Parâmetros¶
component - Component - Componente alvo.
- event - evento alvo.
Retorno¶
Nenhum
clearEventHandler¶
clearEventHandler(component)
Remove todos os eventos do componente
Parâmetros¶
- component - Component - Componente
Retorno¶
Nenhum.
addEventHandler¶
Component#addEventHandler(component, event)
Adiciona um evento no componente.
Parâmetros¶
- component - Component - Componente alvo.
- event Event - evento alvo.
Retorno¶
retorna true ou false
isFocusable¶
Component#isFocusable(component)
Verifica se o componente permite foco.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
retorna true ou false
setFocusable¶
Component#setFocusable(component, value)
Atribui ao componente a possibilidade de foco.
Parâmetros¶
- component - Component - Componente alvo.
- value - Boolean true ou false.
Retorno¶
Nenhum
setFocus¶
Component#setFocus(component, value)
Atribui foco ao componente, baseado no parâmetro value.
Parâmetros¶
- component - Component - Componente alvo.
- value - Boolean true ou false.
Retorno¶
Nenhum
isFocused¶
Component#isFocusable(component)
Valida se o componente esta focado.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
Retorna true ou false
isEnable¶
Component#isEnable(component)
Verifica se o componente está habilitado.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna true ou false
setEnable¶
Component#setEnable(component, value)
Habilita o componente.
Parâmetros¶
- component - Component - Componente alvo.
- value - Boolean - true ou false.
Retorno¶
Nenhum
getProperties¶
Component#getProperties(component)
Obtém as propriedades do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna um Map com as propriedades.
getPropertiesCustomLoaded¶
Component#getPropertiesCustomLoaded(component)
Obtém as propriedades da custom carregada no componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna as propriedades do componente.
getStyleName¶
Component#getStyleName(component)
Obtém o nome do arquivo jcss do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
String contendo o nome do arquivo.
setStyleName¶
Component#setStyleName(component, styleName)
Altera o arquivo jcss do componente.
Parâmetros¶
- component - Component - Componente alvo.
- styleName - String - nome do arquivo jcss.
Retorno¶
Nenhum
getModified¶
Component#getModified(component)
Verifica se o componente precisa ser desenhado.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
true ou false
setModified¶
Component#setModified(component, mod)
Atribui um booleano indicando se o componente precisa ser desenhado.
Parâmetros¶
- component - Component - Componente alvo.
- mod - Boolean - true ou false../>
Retorno¶
Nenhum
getBackgroundEnabled¶
Component#getBackgroundEnabled(component)
Verifica se o background do componente está habilitado.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
true ou false
setBackgroundEnabled¶
Component#setBackgroundEnabled(component, enable)
Atribui um booleano indicando se o background do componente está habilitado ou não.
Parâmetros¶
- component - Component - Componente alvo.
- enable - Boolean - true ou false.
Retorno¶
Nenhum
hasSubComponents¶
Component#hasSubComponents(component)
Verifica se o background do componente está habilitado.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
true ou false
setHasSubComponents¶
Component#setHasSubComponents(component, has)
Atribui um booleano indicando se o componente é um subcomponente ou não.
Parâmetros¶
- component - Component - Componente alvo.
- has - Boolean - true ou false.
Retorno¶
Nenhum
isPaginator¶
Component#isPaginator(component)
Verifica se o componente é um paginador.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
true ou false
setPaginator¶
Component#setPaginator(component, pag)
Atribui um booleano indicando se o componente é um paginador ou não.
Parâmetros¶
- component - Component - Componente alvo.
- pag - Boolean - true ou false.
Retorno¶
Nenhum
getText¶
Component#getText(component)
Obter o texto do componente.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
String contendo o texto
setText¶
Component#setText(component, text)
Atribui um texto ao componente.
Parâmetros¶
- component - Component - Componente alvo.
- text - String - texto a ser adicionado no componente.
Retorno¶
Nenhum
drawBackgroundFromStyle2¶
Component#drawBackgroundFromStyle2(component)
Desenha fundo do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Nenhum
drawBackgroundFromStyle¶
Component#drawBackgroundFromStyle(component, style, code)
Desenha fundo do componente.
Parâmetros¶
- component - Component - Componente alvo.
- style - String - arquivo de layout.
- code - Integer - código da tecla.
Retorno¶
Nenhum
drawBackgroundFromProperties¶
drawBackgroundFromProperties(properties, code, enabled)
Desenha fundo do componente baseado nas propriedades passadas.
Parâmetros¶
- properties - Map - mapa com as propriedades.
- code - Integer - código da tecla.
- enabled - Boolean - boleano indicando se o componente está habilitado.
Retorno¶
Nenhum
getY¶
Component#getY(component)
Obtém a coordenada Y do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna um Inteiro
getX¶
Component#getX(component)
Obtém a coordenada X do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna um Inteiro
getW¶
Component#getW(component)
Obtém a width do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna um Inteiro
getH¶
Component#getH(component)
Obtém a height do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
Retorna um Inteiro
setX¶
Component#setX(component, X)
Atribui a coordenada X ao componente.
Parâmetros¶
- component - Component - Componente alvo.
- X - Integer - Valor da coordenada X.
Retorno¶
Nenhum
setY¶
Component#setY(component, Y)
Atribui a coordenada Y ao componente.
Parâmetros¶
- component - Component - Componente alvo.
- Y - Integer - Valor da coordenada Y.
Retorno¶
Nenhum
setW¶
Component#setW(component, W)
Atribui o width ao componente.
Parâmetros¶
- component - Component - Componente alvo.
- W - Integer - Valor do Width.
Retorno¶
Nenhum
setH¶
Component#setH(component, H)
Atribui o height ao componente.
Parâmetros¶
- component - Componente alvo.
- H - Integer - Valor do height.
Retorno¶
Nenhum
getCenterX¶
Component#getCenterX(component)
Obtém a posição central da coordenada X
Parâmetros¶
- component - Componente alvo.
Retorno¶
retorna um inteiro
getCenterY¶
Component#getCenterY(component)
Obtém a posição central da coordenada Y
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
retorna um inteiro
getFontName¶
Component#getFontName(component)
Obtém o nome da fonte do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
retorna uma String.
getFontColor¶
Component#getFontColor(component)
Obtém a cor da fonte do componente.
Parâmetros¶
component - Component - Componente alvo.
Retorno¶
inteiro com a cor no formato decimal.
getimageName¶
Component#getimageName(component)
Obtém o nome da imagem atribuída ao componente.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
String contendo o nome da imagem.
getComponents¶
Component#getComponents(component)
Obtém todos o subcomponentes de um componente. Atualmente penas o componente Grid tem subcomponentes.
Parâmetros¶
- component - Component - Componente alvo.
Retorno¶
Uma lista de componentes.
Exemplo¶
use url Component "package://phui#components/components.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; use url Label "package://phui#components/label.wmlsc"; use url Map "package://vm#core/map.wmlsc"; var frame = Frame#create("frame", "invalid"); var label = Label#create("label", "label", "invalid"); var labelProperties = Component#getProperties(label); Map#put(labelProperties, "backgroundColor", 11484477); Component#setX(label, 10); Component#setY(label, 50); Component#setY(label, 50); Component#setW(label, 200); Component#setH(label, 50); Component#setFocusable(label, true); Component#setFocus(label, true); Frame#add(frame, label); Frame#show(frame);
Events¶
| package://phui#components/events.wmlsc |
|---|
Componente que fornece suporte a eventos
create¶
Events#create(event, module, fname, custom)
Cria um novo evento
Parâmetros¶
- event - Nome do evento
- module - Script que irá gerenciar o evento
- fname - Função que executará o evento
- custom - customização do evento
Retorno¶
Retorna o evento criado.
Exemplo¶
use url Events "package://phui#components/events.wmlsc"; var ev1 = Events#create("timer", "package://scripts#meumodulo/scroll_banner.wmlsc", "onTimer", 1);
isEvent¶
Events#isEvent(handler, event)
valida se o handler é um evento.
Parâmetros¶
- handler - Script que irá gerenciar o evento
- event - Nome do evento
Retorno¶
Retorna true ou false
getCustom¶
Events#getCustom(handler)
obtém o custom do componente.
Parâmetros¶
- handler - endereço do componente.
Retorno¶
Retorna o handler do componente.
setCustom¶
Events#setCustom(handler, value)
atribui um valor ao hendler do componente.
Parâmetros¶
- handler - endereço do componente.
- value - valor atribuído.
Retorno¶
Retorna o handler do componente.
call¶
Events#call(handler, params)
- handler - chama o script que ira geranciar o evento passando os seus parametros.
- handler - parametros da função.
Parâmetros¶
- handler - endereço do componente.
- params - valor atribuído.
Retorno¶
Retorna true ou false
Field¶
| package://phui#components/field.wmlsc |
|---|
Componente que fornece suporte a edição de textos
Constantes¶
Constantes Descrição Valor Field#MONEY Dinheiro 0 Field#NUMBER Número 1 Field#STRING Texto 2
Constantes Descrição Valor Field#CHAR_ALFA Caracteres Alfanuméricos 1 Field#CHAR_NUMERICO Caracteres Numéricos 2 Field#CHAR_HIDDEN Caracteres Ocultos 4 Field#CHAR_REWRITE Sobrecrever o texto inicial 8 Field#CHAR_ALFA_LOWER Caractere alfanumérico minúsculo 64 Field#CHAR_ALFA_UPPER Caractere alfanumérico maiúsculo 128
Constante Descrição Valor Field#DIRECTION_LEFT Campo capturado a partir da esquerda 16 Field#DIRECTION_RIGHT Campo capturado a partir da direita 32
Constantes Descrição Valor Field#INPUT_MASK_NUMBERS Máscara para números N Field#INPUT_MASK_LETTERS Máscara para letras L Field#INPUT_MASK_ALFANUM Máscara para alfanuméricos A Field#INPUT_MASK_ANYCHAR Qualquer caractere _
create¶
Field#create(fname, initialValue, mask, min, max, opcoes, mandatory, attrs, styleName)
Cria um edit para captura de um campo
Parâmetros¶
- fname - Nome do componente no arquivo json de estilos
- initialValue - Valor inicial que aparecerá no campo
- mask - Máscara utilizada na entrada do dado
- min - Valor mínimo aceito pelo campo
- max - Valor máximo aceito pelo campo
- opcoes - tipo de caractere e direção de captura do campo. Podem ser combinadas através de or lógico. (ver constantes)
- mandatory - indica se o campo é obrigatório.
- attrs - Lista contendo valores booleanos referente às opçoes respectivamente:
- use T9 - Utiliza teclado T9
- disableRewriteOnKey - desabilita a reescrita do valor
- beepOnKey - beep a cada toque ou tecla pressionada
- clearAll - limpa todo o edit
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o field criado.
Exemplo¶
use url Field "package://phui#components/field.wmlsc"; var quantidade = "1"; var field = Field#create("quantidade", quantidade, "NNx", 1, 2, Field#CHAR_NUMERICO() | Field#CHAR_REWRITE() | Field#DIRECTION_LEFT(), true, [false, true, false, false], invalid);Resultado¶
paint¶
Field#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
onTimer¶
Field#onTimer(frame, component)
Adiciona um tempo que o frame deve esperar de ociosidade para que seja fechado.
Parâmetros¶
- frame - frame alvo
- component - componente que ira aguardar o tempo.
Retorno¶
Nenhum
onKey¶
Field#onKey(frame, component, key)
captura teclas pressionadas no componente.
Parâmetros¶
- frame - frame onde o componente está inserido.
- component - componente que será notificado pelo evento.
- key - tecla que vai dispara a notificação.
Retorno¶
Nenhum
getText¶
Field#getText(component)
obtém o conteúdo do field.
Parâmetros¶
- component - componente alvo
Retorno¶
retorna uma string.
hiddenText¶
Field#hiddenText(text, useT9)
esconde o texto do filed.
Parâmetros¶
- text - texto do field
- useT9 - boolean que habilita o uso do teclado T9.
Retorno¶
retorna uma string com caracteres "*".
Frame¶
| package://phui#components/frame.wmlsc |
|---|
Componente que encapsula outros componentes (form)
create¶
Frame#create(framename, styleName)
Cria um novo frame
Parâmetros¶
- framename - Nome do frame no arquivo json
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o frame criado.
Exemplo¶
use url Frame "package://phui#components/frame.wmlsc"; var frame = Frame#create("main", invalid);
createExt¶
Frame#createExt(framename, title, styleName)
Cria um novo frame, com título definido.
Parâmetros¶
- framename - Nome do frame no arquivo json
- title - Titulo do frame.
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o frame criado.
Exemplo¶
use url Frame "package://phui#components/frame.wmlsc"; var frame = Frame#createExt("main", "titulo", invalid);
show¶
Frame#show(frame)
mostra o frame.
Parâmetros¶
- frame - componente alvo.
Retorno¶
Nenhum
add¶
Frame#add(frame, component)
adiciona componentes ao frame.
Parâmetros¶
- frame - componente alvo.
- component - componente que será adicionado ao frame.
Retorno¶
retorna inválido caso o componente já exista no frame.
remove¶
Frame#remove(frame, component)
remove o componente do frame.
Parâmetros¶
- frame - componente alvo.
- component - componente que será removido do frame.
Retorno¶
retorna inválido caso o componente já exista no frame.
removeAll¶
Frame#removeAll(frame)
remove todos os componentes do frame.
Parâmetros¶
- frame - componente alvo.
Retorno¶
booleano, true em caso de sucesso ou false se não é possível limpar a lista. Caso não seja possível utilizar os parâmetros invalid será retornado.
getComponent¶
Frame#getComponent(frame, compName)
obtém um componente do frame.
Parâmetros¶
- frame - componente alvo.
- compName - componente que se deseja obter.
Retorno¶
retorna o componente alvo em caso de sucesso e invalid caso não encontrado
invalidate¶
Frame#invalidate(frame)
atualiza o frame.
Parâmetros¶
- frame - componente alvo.
Retorno¶
Nenhum
invalidateExt¶
disponivel a partir da versao 1.4.22.7 da suíte >Frame#invalidateExt(frame, clearTouch)
atualiza o frame com a possibilidade de limpar ou não o Touch da screen.
Parâmetros¶
- frame - componente alvo.
- clearTouch - boleano, indica se deve ou nao limpar o touch.
Retorno¶
Nenhum
getResultCode¶
Frame#getResultCode(frame)
Captura o código ASCII da tecla pressionada no frame.
Parâmetros¶
- frame - componente alvo.
Retorno¶
retorna o código ASCII da tecla pressionada.
setResultCode¶
Frame#setResultCode(frame, value)
atribui um código para posterior validação.
Parâmetros¶
- frame - componente alvo.
- value - código que se deseja atribuir ao frame para capturar na saída.
Retorno¶
Nenhum
Grid¶
| package://phui#components/grid.wmlsc |
|---|
Componente que fornece suporte a Grids
Constantes¶
Constante Valor Descrição DEFAULT_OPTIONS 0 Opção padrão. NUMERIC_SELECTION 4 Habilita seleção numérica dos itens (1-9). SHOW_ITEM_INDEX 8 Exibe o índice nos itens. AUTO_ARRENGE 32 Distribui automaticamente os itens na tela.
Função Descrição create Cria um novo grid. getHeight Obtém a altura do grid. getComponent Obtém um componente que esta inserido dentro do grid. setMaxItens Indica qual é a quantidade máxima de itens selecionáveis. resetCustom Redefine as configurações do grid para os valores default.
create¶
Grid#create(fname, items, options, styleName)
Cria um novo scroll.
Parâmetros:¶
- fname - string - nome do Grid no arquivo de estilo;
- items - Matriz (PhList de PhList) - de componentes que serão exibidos no Grid. Esta matriz define o posicionamento dos items no Grid e deve obedecer o seguinte formato;
[ [col0, col1, col2], //linha [col3, col4, col5], //linha ];Os items em cada linha podem ter áreas diferentes (W/H). A altura de cada linha será definida pelo item de maior altura da linha. Caso a opção AUTO_ARRANGE() esteja habilitada, não é necessaria a definição de posicionamento na matriz, permitindo a definição de uma lista com os items ([col0, col1, col2, col3, col4, ../]). Neste caso o posicionamento será feito de acordo com a área dos componentes.
- options - constant - Grid#NUMERIC_SELECTION(), Grid#SHOW_ITEM_INDEX(), Grid#AUTO_ARRENGE().
As opções podem ser acumuladas através do | (bitwise OR) Ex: Grid#NUMERIC_SELECTION() | Grid#SHOW_ITEM_INDEX() | Grid#AUTO_ARRANGE().
- styleName - string - com o nome do arquivo de estilo que será usado no Grid. Se for passado "" ou invalid, será utilizado o arquivo de estilo padrão (JCSS).
Retorno:¶
Retorna o grid.
Exemplo¶
use url Grid "package://phui#components/grid.wmlsc"; use url Button "package://phui#components/button.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; extern function teste() { var jcss = "JCSS"; var frame = Frame#create("frame", jcss); var bt1 = Button#create("btMenu", "BUTTON 1", jcss); var bt2 = Button#create("btApp", "BUTTON 2", jcss); var bt3 = Button#create("btFuncMenu", "BUTTON 3", jcss); var bt4 = Button#create("btYes", "BUTTON 4", jcss); var items = [ [bt1, bt2], [bt3, bt4] ]; var grid = Grid#create("gridExample", items, Grid#DEFAULT_OPTIONS(), ""); Frame#add(frame, grid); Frame#show(frame); }**************************************************************************************
getHeight¶
Obtém a altura do grid.
Parâmetros¶
- grid - Grid criado em Grid#create() - componente alvo;
Retorno¶
Inteiro com o height do grid criado.
getComponent¶
Grid#getComponent(grid, compName)
Obtém um componente que esta inserido dentro do grid.
Parâmetros¶
- grid - Grid criado em Grid#create() - componente alvo;
- compName - string - nome do componente no arquivo de estilo;
Retorno¶
retorna o componente que está dentro do grid ou não encontrando invalid.
setMaxItens¶
Grid#setMaxItens(component, maxItens)
A setMaxItems é usada quando a opção NUMERIC_SELECTION() está habilitada. Serve para indicar a quantidade máxima de itens selecionáveis;
Parâmetros¶
- component - Grid criado em Grid#create() - componente alvo.
- maxItens - integer - quantidade máxima de componentes.
Retorno¶
Nenhum
resetCustom¶
Grid#resetCustom(component)
Redefine as configurações de grid para os valores padrão.
Parâmetros¶
- component - Grid criado em Grid#create() - componente alvo.
Retorno¶
Nenhum
Hotkey¶
| package://phui#components/hotkey.wmlsc |
|---|
Componente que fornece suporte a teclas de atalho.
create¶
Hotkey#create(hotKeys)
Cria uma hotkey para ser utilizada
Parâmetros¶
- hotKeys - Map - Pacote package://vm#core/map.wmlsc que possui:
- chave: codeHotkey - Integer - código que representa a tecla que ficará como atalho.
- valor: modulo - String - modulo que se deseja chamar ao pressionar a tecla de atalho.
Retorno¶
Nenhum.
Exemplo:
use url MsgAdmin "package://phast#i18n/admin.wmlsc"; use url Field "package://phui#components/field.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; use url Hotkey "package://phui#components/hotkey.wmlsc"; use url Label "package://phui#components/label.wmlsc"; use url Status "package://phui#components/status.wmlsc"; use url Timer "package://phui#components/timer.wmlsc"; use url ScreenUI "package://phui#dialogs/screen.wmlsc"; use url Input "package://phui#input/input.wmlsc"; use url Map "package://vm#core/map.wmlsc"; /******************************************************************************/ function POS320X240() {return "320x240";} /******************************************************************************/ extern function execute() { createFrame(); } /******************************************************************************/ function createFrame() { var frame = Frame#createExt("Memo", "Funcao", ""); var timer = Timer#create("timer", 30000, true); var label = Label#create("title", "FUNÇÃO F2", ""); var field = Field#create("", "", invalid, 0, 2, (Input#DIRECTION_LEFT() | Input#CHAR_NUMERICO()), String.getValue('.'), false, ""); Frame#add(frame, Status#create("status", "")); Frame#add(frame, timer); Frame#add(frame, field); Frame#add(frame, label); if (getSizeScreenDevice() == POS320X240()) { var footer = Label#create("footer", ScreenUI#FooterMsg("F2", invalid, MsgAdmin#BT_FUNCS(), invalid), ""); Frame#add(frame, footer); } Frame#add(frame, createHotkey(PhKeyBoard.KEY_F2, "package://samplehotkey/main.wmlsc#onKey")); Frame#show(frame); } /******************************************************************************/ function createHotkey(keyCode, module) { var hotkeys = Map#create(); Map#put(hotkeys, keyCode, module); return Hotkey#create(hotkeys); } /******************************************************************************/ function getSizeScreenDevice() { var x = PhDisplay.maxPxWidth(); var y = PhDisplay.maxPxHeight(); return x + "x" + y; } /******************************************************************************/ extern function onKey(frame, component, key) { var result = false; if (PhKeyBoard.KEY_F2 == key) { result = true; Dialogs.alert("I was called"); } if (result) { Frame#setResultCode(frame, key); } return result; } /******************************************************************************/
Image¶
| package://phui#components/image.wmlsc |
|---|
Componente que fornece suporte a renderização de imagens
create¶
Image#create(fname, styleName)
Cria uma nova imagem
Parâmetros¶
- fname - Nome da imagem no arquivo json
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna a imagem criada.
Exemplo¶
use url Image "package://phui#components/image.wmlsc"; var image = Image#create("Background", invalid);
paint¶
Image#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
setImgName¶
Image#setImgName(component, imgName)
Atribui o nome da imagem
Parâmetros¶
- component - componente alvo.
- imgName - nome que será atribuído a imagem.
Retorno¶
Nenhum
getImgName¶
Image#getImgName(component)
obtém o nome da imagem.
Parâmetros¶
- component - componente alvo.
Retorno¶
retorna o nome da imagem.
Info¶
| package://phui#input/info.wmls |
|---|
Implementação responsável por fornecer informações em duas colunas(chave e valor).
Sumário¶
Função Descrição show exibe informação na tela do dispositivo printInfos exibe informação no comprovante impresso
Constantes¶
Constantes Valor Info#ALL 0 Info#ONE 1 Info#PAPER_TIMEOUT 3000 Info#BEEP_TIMEOUT 50 Info#LINES_FEED 4
show¶
Info#show(title, sections, timeout, msgs, styleName, showPrint)
Monta um componente para navegação de um map de string com navigation e botão de impressão
Parâmetros¶
- title - string - texto com o título da informação;
- sections - map - mapa aninhado de mapas;
- timeout - integer - positivo que gerencia o tempo de exibição;
msgs - list - Lista de strings onde:
msgs[0] = string do botão sair
- msgs[1] = string para informar quando a impressão for realizada
- msgs[2] = string para informar quando não houver papel
- msgs[3] = string para informar o número do Sim card
- msgs[4] = string para informar quando o Sim Card não for detectado
- msgs[5] = string para informar o número serial
msgs[6] = *string* para informar a versão do SO
styleName - string - nome do arquivo de estilo que pode receber invalid ou arquivo de estilo personalizado;
- showPrint - boolean - Mostra botão de sair
Retorno¶
Nenhum
Exemplo:
use url Info "package://phui#input/info.wmlsc"; var mapConteiner = Map#create(); var mapDetail = Map#create(); Map#put(mapDetail, "Nome", "Jose da Silva"); Map#put(mapDetail, "Telefone", "99 987654321"); Map#put(mapDetail, "Email", "jose@gmail.com"); Map#put(mapConteiner, "My section one", mapDetail); Map#put(mapConteiner, "My section two", invalid); Info#show("my title", mapConteiner, 10000, ["Print","Printing../", "No papel", "Sim card number","No Sim card detected","Serial number","Version"], invalid, false);
printInfos¶
Info#printInfos(title, sections, mode, msgs)
Implementação de exibição das informações em comprovante impresso.
Parâmetros¶
- title - string - de texto com o título da informação;
- sections - list - mapeada chave e valor;
- mode - Info#ALL() para impressão sem cabeçalho ou Info#ONE() para impressão de cabeçalhos baseado no parâmetro sections
- msgs - list - Lista de strings onde:
- msgs[0] = string do botão sair
- msgs[1] = string para informar quando a impressão for realizada
- msgs[2] = string para informar quando não houver papel
- msgs[3] = string para informar o número do Sim card
- msgs[4] = string para informar quando o Sim Card não for detectado
- msgs[5] = string para informar o número serial
- msgs[6] = *string* para informar a versão do SO
Retorno¶
Nenhum
Exemplo:
use url Info "package://phui#input/info.wmlsc"; var sections = Map#create(); Map#put(sections, "My header section one", 1); Map#put(sections, "My header section two", 2); Info#printInfos("Hello World", sections, Info#ALL(), ["Print","Printing../", "No papel", "Sim card number","No Sim card detected","Serial number","Version"]);
Info Components¶
package://phui#components/info.wmlsc Cria um componente info.
Sumário¶
Funções Descrição create Cria um componente info. createExt Cria um componente info com botão. paint Desenha um componente no frame
create¶
>Info#create(fname, title, sections, styleName)
Cria um componente info.
Parâmetros¶
- fname - string - nome do componente no arquivo de estilo;
- title - string - com o titulo do componente;
- sections - Map - mapa aninhado de mapas;
- styleName - string - nome do arquivo de estilo ou invalid;
Retorno¶
Nenhum.
Exemplo¶
use url Map "package://vm#core/map.wmlsc"; use url Info "package://phui#components/info.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; extern function teste() { var map = Map#create(); Map#put(map, "Nome 1", 1); Map#put(map, "Nome 2", 2); var map2 = Map#create(); Map#put(map, "Nome 3", 1); Map#put(map, "Nome 4", 2); var sections = Map#create(); Map#put(sections, "Teste da seção 1", map); Map#put(sections, "Teste da seção 2", map2); var frame = Frame#create("frame", invalid); var info = Info#create("centerMemo", "Título", sections, invalid); Frame#add(frame, info); Frame#show(frame); }**************************************************************************************
createExt¶
>Info#createExt(fname, title, sections, buttPrint, styleName)
Cria um componente info.
Parâmetros¶
- fname - string - nome do componente no arquivo de estilo;
- title - string - com o titulo do componente;
- sections - Map - mapa aninhado de mapas;
- buttPrint - integer - contendo o código da tecla associado ao componente no arquivo de estilo;
- styleName - string - nome do arquivo de estilo ou invalid;
Retorno¶
Nenhum.
Exemplo¶
use url Map "package://vm#core/map.wmlsc"; use url Info "package://phui#components/info.wmlsc"; use url Button "package://phui#components/button.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; extern function teste() { var map = Map#create(); Map#put(map, "Nome 1", 1); Map#put(map, "Nome 2", 2); var map2 = Map#create(); Map#put(map, "Nome 3", 1); Map#put(map, "Nome 4", 2); var sections = Map#create(); Map#put(sections, "Teste da seção 1", map); Map#put(sections, "Teste da seção 2", map2); var btPrint = Button#create("btPrint", "Imprimir", invalid); var frame = Frame#create("frame", invalid); var info = Info#createExt("centerMemo", "Título", sections, 10 , invalid); Dialogs.alert(info); Frame#add(frame, btPrint); Frame#add(frame, info); Frame#show(frame); }**************************************************************************************
paint¶
Info#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
InputUI¶
| package://phui#input/input.wmlsc |
|---|
Este módulo fornece funções para captura interativa de dados.
Sumário¶
Função Descrição inputBoolean interface com botões de confirmação. inputBooleanWithImage interface com botões de confirmação e imagem. inputCurrency interface de inserção de valor financeiro. inputString interface para inserção de string. inputNumber interface para inserção de valores numéricos. inputNumberExt interface para inserção de valores numéricos.
Constantes¶
Constantes Valor Descrição InputUI#INPUT_NONE 0 Retorno de input sem conteúdo. InputUI#INPUT_ABORT 1 Retorno do input se abortada operação. InputUI#INPUT_OK 2 Retorno do input ao ser pressionada a tecla ENTER. InputUI#INPUT_TIMEOUT 3 Retorno do input quando ocorre timeout. InputUI#INPUT_PREV 4 Retorno do input de navegação para o campo anterior. InputUI#INPUT_NEXT 5 Retorno do input de navegação para o próximo campo. InputUI#FIELD_OK 6 Retorno do input quando o campo está preenchido corretamente.
Constantes Valor Descrição InputUI#CHAR_ALFA 1 Caracteres alfanuméricos. InputUI#CHAR_NUMERICO 2 Caracteres numéricos. InputUI#CHAR_HIDDEN 4 Caracteres ocultos. InputUI#CHAR_REWRITE 8 Sobrecrever o texto inicial. InputUI#CHAR_ALFA_LOWER 64 Caractere alfanumérico minúsculo InputUI#CHAR_ALFA_UPPER 128 Caractere alfanumérico maiúsculo
Constantes Valor Descrição InputUI#DIRECTION_LEFT 16 Campo capturado a partir da esquerda. InputUI#DIRECTION_RIGHT 32 Campo capturado a partir da direita.
Constantes Valor Descriação InputUI#BEEP_KEY 30 Tempo em milissegundos do som de quando uma tecla é pressionada. InputUI#BEEP_MESSAGE 50 Tempo em milissegundos do som do beep de quando uma mensagem é exibida. InputUI#BEEP_ALERT 100 Tempo em milissegundos do som do beep de quando um alerta é exibido. InputUI#BEEP_ERROR 500 Tempo em milissegundos do som do beep de quando uma mensagem de erro é exibida.
inputBoolean¶
InputUI#inputBoolean(title, hint, timeout, message, msgYes, msgNo, defaultValue, output)
Tela de confirmação que fornece uma interface com botões de confirmação.
Parâmetros¶
- title - string ou list - com os dados de títulos para o componente inputBoolean onde:
title[0] titulo - string;
title[1] subtitulo - string;- hint - string - com informação sobre o componente;
- timeout - integer - em milissegundos se for 0 a tela permanece em execução indefinidamente;
- message - string - com mensagem a ser exibida;
- msgYes - string - que da título ao botão de confirmação positiva;
- msgNo - string - que da título ao botão de confirmação negativa;
- defaultValue - boolean - com valor default do componente;
- output - PhType.BOOLEAN - tipo lógico (01 Byte) 0 para FALSE ou diferente de zero para TRUE;
Retorno¶
inteiro definido nas constantes de retorno.
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; use url Message "package://tefui#ui/message.wmlsc"; var output = PhType.create(PhType.BOOLEAN); var res = InputUI#inputBoolean(["Texto a ser apresentado."], "Dica", 0, "Deseja Continuar?", "SIM", "NAO", true, output); Message#showMessage("Output: " + output + "|Valor: " +res , Message#DELAY_ALERT(), Message#BEEP_MESSAGE());Exemplo de saída em tela:
Output: true Valor: 1
inputBooleanWithImage¶
InputUI#inputBooleanWithImage(anim, title, hint, timeout, message, msgYes, msgNo, defaultValue, output, attrs)
Tela de confirmação que fornece uma interface com botões de confirmação e imagem personalizavel.
Parâmetros¶
- anim - imagem contida no arquivo JCSS.
- title - string ou list - com os dados de titulos para o componente inputBooleanWithImage onde:
title[0] titulo - string;
title[1] subtitulo - *string;- hint - string - com informação sobre o componente;
- timeout - integer - em milissegundos se for 0 a tela permanece em execução indefinidamente;
- message - string - com mensagem a ser exibida;
- msgYes - string - que da título ao botão de confirmação positiva;
- msgNo - string - que da título ao botão de confirmação negativa;
- defaultValue - boolean - com valor default do componente;
- output - PhType.BOOLEAN - tipo lógico (01 Byte) 0 para FALSE ou diferente de zero para TRUE;
- attrs - list ou invalid - em caso de invalid mantém a navegação padrão e em caso de PhList armazena se houve indicação de navegação com uma quantidade fixa de elementos:
attrs[0] - key left;
attrs[1] - key rigth;Retorno¶
true ou falso e descrição do retorno
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; var output = PhType.create(PhType.BOOLEAN); InputUI#inputBooleanWithImage(Style#IMAGE_CONFIRMATION(), "", invalid, 0, "Deseja Continuar?", "SIM", "NAO", true, output, invalid); Helper#showMessage(output);Saída em tela:
true ou false
inputCurrency¶
InputUI#inputCurrency(title, ¤cy, acceptZero, attrs)
Componente de tela que fornece uma interface de inserção de valor financeiro.
Parâmetros¶
- title - string ou list - com os dados de titulos para o componente inputCurrency onde:
title[0] titulo - string;
title[1] subtitulo - string;
title[2] simbolo - string;- currency - inteiro - com valor inicial e variável de saída do input (por referência) representa o valor informado pelo usuário;
- acceptZero - boolean - que indica se o input deve aceitar o valor 0 como válido;
- attrs - list ou integer - caso seja um numérico será considerado como o timeout em milissegundos, caso seja um PhList pode ser uma quantidade variável de parâmetros:
attrs[0] - timeout (default: 30000);
attrs[1] - Quantidade máxima de dígitos do input (default: 9);
attrs[2] - Código da tecla para indicar navegação à esquerda (O input retornará INPUT_PREV() quando esta tecla for pressionada. Default : 0);
attrs[3] - Código da tecla para indicar navegação à direita (O input retornará INPUT_NEXT() quando esta tecla for pressionada. Default: 0);
attrs[4] - Caractere separador de casas decimais (default: ",");
attrs[5] - Caractere separador de milhares (default: ".");Retorno¶
inteiro referente ao valor informado.
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; var valor = 10; InputUI#inputCurrency(["Valor", "digite um valor", "R$"], &valor, true, 30000); Dialogs.alert("Valor informado: "+ valor);Exemplo de saída em tela:
Valor informado : 10
inputString¶
InputUI#inputString(title, hint, &value, mask, min, max, opcoes, charEmpty, attrs)
Componente de tela que fornece uma interface de inserção de string.
Parâmetros¶
- title - string ou list - com os dados de título e subtítulo para o componente inputString onde:
title[0] titulo - string;
title[1] subtitulo - string;- hint - string - com informação sobre o componente;
- value - string ou integer - com valor inicial e variável de saída do input (por referência) representa o valor informado pelo usuário;
- mask - string - contendo a mascara;
- min - integer - que parametriza a quantidade mínima de caracteres numéricos;
- max - integer - que parametriza a quantidade máxima de carateres numéricos;
- opcoes - integer - constante nativa com opção de validação - vide a lista de constantes aqui;
- charEmpty - string - caractere usado para preencher o input quando estiver vazio;
- attrs - list ou boolean - em caso de boolean indica se o input é ou não obrigatório em caso de PhList que pode ser:
attrs[0] - indica se o input é ou não obrigatório;
attrs[1] - timeout;
attrs[2] - código da tecla para indicar navegação à esquerda (O input retornará INPUT_PREV() quando esta tecla for pressionada. Default : 0)
attrs[3] - código da tecla para indicar navegação à direita (O input retornará INPUT_NEXT() quando esta tecla for pressionada. Default: 0)Retorno¶
string informada
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; use url Message "package://tefui#ui/message.wmlsc"; var ip = "111111111111"; InputUI#inputString("Endereço Ip:", invalid, &ip, "NNN.NNN.NNN.NNN", 1, 12,(InputUI#DIRECTION_LEFT() | InputUI#CHAR_NUMERICO()), String.getValue('.'), [true, 10000]); Message#showMessage("IP capturado:|" + ip, Message#DELAY_ALERT(), Message#BEEP_MESSAGE());Saída em tela:
IP capturado : 111.111.111.111
inputNumber¶
InputUI#inputNumber(title, &number, min, max)
Componente de tela que fornece uma interface de inserção de número.
Parâmetros¶
- title - string ou list - com os dados de titulos para o componente inputNumber onde:
title[0] titulo - string;
title[1] subtitulo - string;- number - integer - com valor inicial e variável de saída do input (por referência) representa o valor informado pelo usuário;
- min - integer - que parametriza a quantidade mínima de caracteres numéricos;
- max - integer - que parametriza a quantidade máxima de carateres numéricos;
Retorno¶
inteiro definido nas constantes de retorno.
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; use url Message "package://tefui#ui/message.wmlsc"; var number = 111; InputUI#inputNumber(["Input", "digite"], &number, 2, 10); Message#showMessage("Número digitado:|" + number, Message#DELAY_ALERT(), Message#BEEP_MESSAGE());Saída em tela:
Número digitado : 111
inputNumberExt¶
InputUI#inputNumber(title, &number, min, max, attrs)
Componente de tela que fornece uma interface de inserção de número.
Parâmetros¶
- title - string ou list - com os dados de titulos para o componente inputNumber onde:
title[0] titulo - string;
title[1] subtitulo - string;- number - integer - com valor inicial e variável de saída do input (por referência) representa o valor informado pelo usuário;
- min - integer - que parametriza a quantidade mínima de caracteres numéricos;
- max - integer - que parametriza a quantidade máxima de carateres numéricos;
- attrs - list ou boolean - em caso de boolean indica se o input é ou não obrigatório em caso de PhList que pode ser:
attrs[0] - indica se o input é ou não obrigatório;
attrs[1] - timeout;
attrs[2] - código da tecla para indicar navegação à esquerda (O input retornará INPUT_PREV() quando esta tecla for pressionada. Default : 0)
attrs[3] - código da tecla para indicar navegação à direita (O input retornará INPUT_NEXT() quando esta tecla for pressionada. Default: 0)Retorno¶
inteiro definido nas constantes de retorno.
Exemplo:¶
use url InputUI "package://phui#input/input.wmlsc"; use url Message "package://tefui#ui/message.wmlsc"; var number = 111; InputUI#inputNumberExt(["Input", "digite"], &number, 2, 10, false); Message#showMessage("Número digitado:|" + number, Message#DELAY_ALERT(), Message#BEEP_MESSAGE());Saída em tela:
Número digitado : 111
Keyboard¶
| package://phui#components/keyboard.wmlsc |
|---|
Componente que fornece suporte a captura de teclas. Renderiza um teclado QWERTY no dispositivo.
create¶
Keyboard#create(fname, styleName, options)
Cria um novo keyboard
Parâmetros¶
- fname - Nome do keyboard no arquivo json
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
- options - Opções do teclado. Ver "Constantes", tabela 2.
Retorno¶
Retorna a imagem criada.
Exemplo¶
use url Keyboard "package://phui#components/keyboard.wmlsc"; use url Field "package://phui#components/field.wmlsc"; var opcoes = Field#CHAR_ALFA() | Field#CHAR_ALFA_LOWER() | Field#CHAR_ALFA_UPPER(); var keyb = Keyboard#create("keyb", invalid, opcoes );
paint¶
Keyboard#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
onKey¶
Keyboard#onKey(frame, component, key)
evento que será disparado ao presionar uma tecla.
Parâmetros¶
- frame - frame onde o componente está inserido.
- component - componente que será notificado pelo evento.
- key - tecla que vai dispara a notificação.
Retorno¶
Nenhum
setType¶
Keyboard#setType(component, type)
atribui o tipo de keyboard
Parâmetros¶
- component - componente alvo.
- type - Tipo de teclado.
Retorno¶
Nenhum
getType¶
Keyboard#getType(component)
obtém o tipo de keyboard
Parâmetros¶
- component - componente alvo.
Retorno¶
retorna o tipo do teclado.
setState¶
Keyboard#setState(component, state)
atribui o status de keyboard
Parâmetros¶
- component - componente alvo.
- state - status.
Retorno¶
Nenhum
getState¶
Keyboard#getState(component)
obtém o status do keyboard
Parâmetros¶
- component - componente alvo.
Retorno¶
retorna o status do teclado.
Label¶
| package://phui#components/label.wmlsc |
|---|
Componente que fornece suporte a escrita de labels
create¶
Label#create(fname, text, styleName)
Cria um novo label
Parâmetros¶
- fname - Nome do label no arquivo json
- text - Texto que será exibido no label
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna a imagem criada.
Exemplo¶
use url Label "package://phui#components/label.wmlsc"; var label = Label#create("qtd_title", "Quantidade", "myJCSS");
createExt¶
Label#createExt(fname, text, styleName, attrs)
Cria um novo label
Parâmetros¶
- fname - Nome do label no arquivo json
- text - Texto que será exibido no label
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
- attrs - Boolean que indicará se deseja persistir no repositório ou Array de Atributos de modificação. attrs[0] - Persistency - booleano - Booleano que indicará se deseja persistir no repositório (cache). attrs[1] - loadProperties - boolean - Booleano que indicará se as propriedades de style serão aplicadas.
Retorno¶
Retorna a imagem criada.
Exemplo¶
use url Label "package://phui#components/label.wmlsc"; var label = Label#createExt("qtd_title", "Quantidade", "myJCSS", false);
paint¶
Label#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
getText¶
Label#getText(component)
obtém o conteúdo da propriedade text do componente.
Parâmetros¶
- component - componente alvo
Retorno¶
Retorna uma string.
setText¶
Label#setText(label, text)
atribui uma string a propriedade text do componente.
Parâmetros¶
- label - componente alvo
- text - texto atribuído.
Retorno¶
Nenhum
split¶
Label#split(label, separator, considerAreaW, splitType)
Prepara o componente para quebrar a string do Label, a quebra em si é feita na função paint.
Parâmetros¶
- label - componente alvo
- separator - caracter separador.
- considerAreaW - inteiro separador.
- splitType - caracter separador.
Retorno¶
Nenhum
Memo¶
| package://phui#components/memo.wmlsc |
|---|
Componente que fornece suporte a um container de textos
create¶
Memo#create(fname, lines, custom, styleName)
Cria um novo memo
Parâmetros¶
- fname - Nome do memo no arquivo json
- lines - PhMemo com as informações a serem exibidas no container
- custom - Customização do componente. Lista contendo 2 ítems:
- scrollIndex - posição do scroller da tela. Para novo memo define-se como 0.
- showButtons - Habilita ou desabilita a exibição dos botões de rolagem.
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o memo criado.
Exemplo¶
use url Memo "package://phui#components/memo.wmlsc"; var memo = PhType.get(PhType.create(PhType.MEMO)); PhList.add(memo, "Opcao 01"); PhList.add(memo, "Opcao 02"); PhList.add(memo, "Opcao 03"); PhList.add(memo, "Opcao 04"); PhList.add(memo, "Opcao 05"); PhList.add(memo, "Opcao 06"); PhList.add(memo, "Opcao 07"); PhList.add(memo, "Opcao 08"); PhList.add(memo, "Opcao 09"); PhList.add(memo, "Opcao 10"); PhList.add(memo, "Opcao 11"); PhList.add(memo, "Opcao 12"); PhList.add(memo, "Opcao 13"); PhList.add(memo, "Opcao 14"); PhList.add(memo, "Opcao 15"); PhList.add(memo, "Opcao 16"); PhList.add(memo, "Opcao 17"); PhList.add(memo, "Opcao 18"); PhList.add(memo, "Opcao 19"); PhList.add(memo, "Opcao 20"); var componentMemo = Memo#create("resumo", memo, [0, true], invalid);
paint¶
Memo#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
down¶
Memo#down(component, step)
Coloca o cursor para baixo dentro do Memo.
Parâmetros¶
- component - componente alvo.
- step - quantos passos o cursor vai para baixo.
Retorno¶
Retorna true ou false
up¶
Memo#up(component, step)
Coloca o cursor para baixo dentro do Memo.
Parâmetros¶
- component - componente alvo.
- step - quantos passos o cursor vai para baixo.
Retorno¶
Retorna true ou false
back¶
Memo#back(frame)
Retorna o código de result para o frame.
Parâmetros¶
- frame - componente alvo.
Retorno¶
Retorna inteiro.
getNumberOfLines¶
Memo#getNumberOfLines(frame)
Retorna o número de linhas de um memo
Parâmetros¶
- frame - nome do componente.
Retorno¶
Retorna inteiro.
alignLineRight¶
Memo#alignLineRight(line)
Realiza o alinhamento a direita.
Parâmetros¶
- line - string de uma linha
Retorno¶
Retorna a string da linha alinhada.
alignLineCenter¶
Memo#alignLineCenter(line)
Realiza o alinhamento ao Centro.
Parâmetros¶
- line - string de uma linha
Retorno¶
Retorna a string da linha alinhada.
alignLineBorders¶
Memo#alignLineBorders(component, left, right)
Realiza o alinhamento de acordo com as bordas informadas.
Parâmetros¶
- component - Componente alvo
- left - tamanho do espaçamento a esquerda.
- right - tamanho do espaçamento a direita.
Retorno¶
Retorna a string da linha alinhada.
alignCenterRight¶
Memo#alignCenterRight(component, center, right)
Realiza o alinhamento a partir do centro para a direita.
Parâmetros¶
- component - Componente alvo
- center - tamanho do espaçamento no centro
- right - tamanho do espaçamento a direita.
Retorno¶
Retorna a string da linha alinhada.
splitMemoLines¶
Memo#splitMemoLines(component, memo)
Realiza o split das linhas de um memo
Parâmetros¶
- component - Componente alvo
- memo - Memo alvo
Retorno¶
Retorna uma lista onde os itens são as linhas do memo.
memoToStr¶
Memo#memoToStr(memo, padding)
Convert um memo em uma String.
Parâmetros¶
- memo - Memo alvo
- padding - espaçamento
Retorno¶
Retorna uma string com o conteúdo do memo.
strToMemo¶
Memo#strToMemo(str)
Convert uma String em um Memo. Só deve ser utilizada para Strings jq quebrados de acordo com a largura disponível.
Parâmetros¶
- str - String alvo
Retorno¶
Retorna um memo.
addSplitLineToMemo¶
Memo#addSplitLineToMemo(memo, line)
Redefine o tamanho de um memo
Parâmetros¶
- memo - Memo alvo.
- line - quantidade de linhas
Retorno¶
Retorna um memo.
Menu¶
| package://tefui#ui/menu.wmlsc |
|---|
Componente que fornece suporte a menus
showMenu¶
Menu#showMenu(title, labels, autosel, attrs)
Exibe um menu.
Parâmetros¶
- title - String - Titulo do menu
- labels - PhList - Labels do menu com 2 itens. labels[0] - PhLIst - Lista que contem os textos que serão exibidos no menu. labels[1] - Integer - Index que indica qual item do menu estará selecionado.
- autosel - Boolean - Se false exibe o menu com qualquer quantidade de labels. Se true quando o menu tiver apenas um label retorna a seleção automaticamente.
- attrs - Boolean ou uma PhList:
attrs[0] - singleColumn - Boolean - Indica se o o menu sera de uma coluna ou não.
attrs[1] - timeout - Integer - timeout definido em milissegundos
attrs[2] - trimTitle - Boolean - Boleano que indicara se deverá ser feito a ação de trim no conteúdo do título.
attrs[3] - margem - Integer - Inteiro que define o tamanho da margem, por default esse falor é 13.
attrs[4] - showExit - Boolean - Indica se deve ser exibido o botão sair no menu, por default o valor é false
attrs[5] - styleName - String - nome do arquivo de estilo.
attrs[6] - upperCase - Boolean - Indica se o texto do menu deve ser caixa alta ou baixa.Retorno¶
Nenhum
showFilteredMenu¶
Menu#showFilteredMenu(title, itens, field_key, field_label, attrs, max_label)
Exibe um menu.
Parâmetros¶
- title - String - Opcional, titulo a ser exibido
- itens - PhList - Lista contendo um Map
- field_key - String - String com a chave para o atributo que representa o código do item
- field_label - String - String com a chave para o atributo que representa a etiqueta do item
- attrs - Integer ou PhList - Tempo de espera milesegundos ou uma lista:
attrs[0] - Integer - tempo de espera ms
attrs[1] - String - texto que será exibido caso um código invalido seja digitado
attrs[2] - Integer - Inteiro que indica qual será o tipo de navegação circular do menu, por default é 0- max_label - Integer - define o tamanho do field_label truncando caso necessário.
Retorno¶
Nenhum
Menu Components¶
| package://phui#components/menu.wmlsc |
|---|
Componente que fornece suporte a menus
create¶
Menu#create(fname, elements, selected, rollIndex, styleName)
Cria um novo menu
Parâmetros¶
- fname - Nome do menu no arquivo json
- elements - Lista contendo as strings com os ítens a ser exibidos
- selected - índice do ítem que está selecionado
- rollIndex - índice da posição no string do elemento selecionado. O menu possibilita a rolagem do texto correntemente selecionado. Esse parâmetro define o índice de onde será exibido o texto no elemento.
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o menu criado.
Exemplo¶
use url Menu "package://tefui#ui/menu.wmlsc"; var opt = 0; var items = []; //itens do Menu PhList.add(items, "Button Create"); PhList.add(items, "Button Event"); PhList.add(items, "Button Two"); opt = Menu#showMenu("Buttons", [items, 0], false, false); if(opt == 0) { sample01(); } else if (opt == 1) { sample02(); } else if (opt == 2) { sample03(); }
onKey¶
Keyboard#onKey(frame, component, key)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente está inserido.
- component - componente que será notificado pelo evento.
- key - tecla que vai dispara a notificação.
Retorno¶
Nenhum
getSelected¶
Menu#getSelected(component)
Retorna o item selecionado do menu.
Parâmetros¶
- component - componente alvo.
Retorno¶
Retorna o item selecionado.
getElements¶
Menu#getElements(component)
Retorna todos os elementos do menu.
Parâmetros¶
- component - componente alvo.
Retorno¶
Retorna uma lista com os elementos do menu.
getCurrentPage¶
Menu#getCurrentPage(component)
Retorna o número da página corrente.
Parâmetros¶
- component - componente alvo.
Retorno¶
Retorna um inteiro.
getMaxPage¶
Menu#getMaxPage(component)
Retorna o maior número da página corrente do menu.
Parâmetros¶
- component - componente alvo.
Retorno¶
Retorna um inteiro.
getPage¶
Menu#getPage(component)
obtém a pagina do menu
Parâmetros¶
- component - componente alvo.
Retorno¶
Retorna um inteiro.
paint¶
Menu#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
onTimer¶
Menu#onTimer(frame, component)
Adiciona um tempo que o frame deve esperar de ociosidade para que seja fechado.
Parâmetros¶
- frame - frame alvo
- component - componente que ira aguardar o tempo.
Retorno¶
Nenhum
getItensPerScreen¶
Menu#getItensPerScreen(menu)
Obtém o percentual dos itens no menu.
Parâmetros¶
- menu - menu alvo
Retorno¶
Nenhum
Navigation¶
| package://phui#components/navigation.wmlsc |
|---|
Componente que fornece suporte a navegações básicas
create¶
Navigation#create(fname, btnIsVisibleList, styleName)
Cria um novo navigation
Parâmetros¶
- fname - Nome do navigation no arquivo json
- btnIsVisibleList - Lista contendo valores booleanos indicando os botões que estarão visíveis, sendo respectivamente:
- up - Botão de navegação para cima
- down - Botão de navegação para baixo
- updisabled - Botão de navegação para cima desabilitado
- downdisabled - Botão de navegação para baixo desabilitado
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o navigation criado.
Exemplo¶
use url Navigation "package://phui#components/navigation.wmlsc"; var btnsVisibleList = [false, false, false, false]; var nav = Navigation#create("nav", btnsVisibleList, invalid);
paint¶
Label#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
PagedMenu¶
| package://phui#components/paged_menu.wmlsc |
|---|
Cria um novo paginador para uso com o componente menu.
create¶
PagedMenu#create(fname, title, menu, styleName)
Cria um novo paginador para uso com o componente menu.
Parâmetros¶
- fname - string - nome do paged_menu no arquivo de estilo JCSS;
- title - Label - componente label exibido na paginação;
- menu - Menu - componente menu criado com a lib Menu;
- styleName - string - nome do arquivo de estilo personalizado pelo usuário (pode ser atribuído invalid ou "";
Retorno¶
Retorna o componente criado.
Exemplo¶
use url PagedMenu "package://phui#components/paged_menu.wmlsc"; use url Menu "package://phui#components/menu.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; use url Label "package://phui#components/label.wmlsc"; extern function teste() { var frame = Frame#create("frame", invalid); var lb = Label#create("lbinfoTitle", "PagedMenu Test", invalid); var menu = Menu#create("menuImagesOneColumn", ["teste1", "teste2", "teste3", "teste4", "teste5", "teste6", "teste7"], 0, 0, invalid, invalid); var pagedMenu = PagedMenu#create("menuImagesOneColumn", lb, menu, invalid); Frame#add(frame, pagedMenu); Frame#show(frame); }
Progress¶
| package://phui#components/progress.wmlsc |
|---|
Componente que fornece suporte a informações de progresso
create¶
Progress#create(fname, textIdle, textProgress, styleName)
Parâmetros¶
- fname - Nome do progress no arquivo json
- textIdle - texto a ser exibido no progress
- textProgress - título do progress
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna o paged_menu criado.
Exemplo¶
use url Progress "package://phui#components/progress.wmlsc"; var progress = Progress#create("phdm", "Exemplo Progresso", "exemplo", invalid);
update¶
Progress#update(component, progress)
Atualiza a informação de progresso de um componente progress
Parâmetros¶
- component - Componente progress criado anteriormente com Progress#create()
- progress - posição do progress
Retorno¶
não há
Exemplo¶
use url Progress "package://phui#components/progress.wmlsc"; Progress#update(progress, 50);
paint¶
Label#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
Scroll¶
| package://phui#components/scroll.wmlsc |
|---|
Componente que fornece suporte a rolagens
create¶
Scroll#create(fname, child, step)
Cria um novo scroll.
Parâmetros¶
- fname - Nome do scroll no arquivo json
- child - Componente memo que será feita a rolagem
- step - passo da rolagem
Retorno¶
Retorna o scroll.
Exemplo¶
use url Scroll "package://phui#components/scroll.wmlsc"; var scroll = Scroll#create("scroll", Memo#create("Teste", memo, 0), 1);
onKey¶
Scroll#onKey(frame, component, key)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente está inserido.
- component - componente que será notificado pelo evento.
- key - tecla que vai dispara a notificação.
Retorno¶
Nenhum
draw¶
Scroll#draw(frame, component)
Pinta o componente no frame
Parâmetros¶
- frame - frame onde o componente está inserido.
- component - componente que será notificado pelo evento.
Retorno¶
Nenhum
Status¶
| package://phui#components/status.wmlsc |
|---|
Componente que fornece uma barra de status
create¶
Status#create(fname, styleName)
Cria uma barra de status
Parâmetros¶
- fname - Nome do status no arquivo json
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna a barra de status
Exemplo¶
use url Status "package://phui#components/status.wmlsc"; var status = Status#create("status", invalid);
onTimer¶
Status#onTimer(frame, component)
Adiciona um tempo que o frame deve esperar de ociosidade para que seja fechado.
Parâmetros¶
- frame - frame alvo
- component - componente que ira aguardar o tempo.
Retorno¶
Nenhum
paint¶
Status#paint(frame, component)
Desenha o componente no frame
Parâmetros¶
- frame - frame onde o componente sera desenhado
- component - componente que será desenhado
Retorno¶
Nenhum
Style¶
| package://phui#components/style.wmlsc |
|---|
Fornece funções para manipulação direta das propriedades dos componentes
Constantes¶
Constante Descrição FONT_FG14 Retorna as propriedades do font no Jcss FRAME Retorna as propriedades do frame no Jcss IMAGE_INPUT_CARD Retorna as propriedades do inputCard no Jcss IMAGE_SEP_INFO Retorna as propriedades do sepinfo no Jcss IMAGE_LOGO_MOBTEF (deprecated) Retorna as propriedades do logo_mobitef no Jcss IMAGE_CONFIRMATION Retorna as propriedades do confirmation no Jcss IMAGE_NOT_AUTHORIZED Retorna as propriedades do notAuthorized no Jcss IMAGE_SHOW_AUTHORIZED (deprecated) Retorna as propriedades do notAuthorized no Jcss IMAGE_SHOW_ERROR Retorna as propriedades do showError no Jcss IMAGE_SHOW_SUCCESS Retorna as propriedades do showSuccess no Jcss IMAGE_PAYSTORE Retorna as propriedades do paystore no Jcss IMAGE_SHOW_LOW_BATTERY Retorna as propriedades do showLowBattery no Jcss ANIMATION_LOADING Retorna as propriedades do loading no Jcss LABEL_INFO_TITLE Retorna as propriedades do lbinfoTitle no Jcss LABEL_INFO_CENTER Retorna as propriedades do lbinfoCenter no Jcss LABEL_INFO_LEFT Retorna as propriedades do lbinfoLeft no Jcss LABEL_INFO_VALUE_LEFT Retorna as propriedades do lbinfoValueLeft no Jcss LABEL_INFO_RIGHT Retorna as propriedades do lbinfoRight no Jcss LABEL_MESSAGE Retorna as propriedades do message no Jcss LABEL_TITLE_ERROR_MSG Retorna as propriedades do titleErrorMsg no Jcss LABEL_TITLE Retorna as propriedades do title no Jcss LABEL_TITLE_FEEDBACK Retorna as propriedades do titleFeedback no Jcss LABEL_MESSAGE_FEEDBACK Retorna as propriedades do messageFeedBack no Jcss LABEL_SUBTITLE Retorna as propriedades do subtitle no Jcss LABEL_HINT Retorna as propriedades do hint no Jcss LABEL_AC_SUBTITLE (deprecated) Retorna as propriedades do AcSubtitle no Jcss LABEL_SUBTITLE_CUSTOM (deprecated) Retorna as propriedades do subtitle_custom no Jcss LABEL_HEADING Retorna as propriedades do lbHeading no Jcss LABEL_TITLE_INPUT Retorna as propriedades do titleInput no Jcss LABEL_TITLE_AC_INPUT (deprecated) Retorna as propriedades do titleAcInput no Jcss LABEL_TITLE_INPUT_CUSTOM (deprecated) Retorna as propriedades do titleInputCustom no Jcss LABEL_PAGED_TITLE_MENU Retorna as propriedades do pagedTitleMenu no Jcss LABEL_TITLE_MENU Retorna as propriedades do titleMenu no Jcss LABEL_ICON_MENU_TITLE Retorna as propriedades do icon_menuTitle no Jcss LABEL_COUNT_MENU_LABEL Retorna as propriedades do count_menuLabel no Jcss LABEL_PRESENTATION Retorna as propriedades do presentation no Jcss LABEL_IDLE_MSG Retorna as propriedades do idleMsg no Jcss LABEL_IDLE_MSG2 (deprecated) Retorna as propriedades do idleMsg2 no Jcss LABEL_IDLE_MSG3 (deprecated) Retorna as propriedades do idleMsg3 no Jcss LABEL_CURRENCY Retorna as propriedades do idleMsg3 no Jcss LABEL_CURRENCY_CUSTOM (deprecated) Retorna as propriedades do currency_custom no Jcss LABEL_BG_CURRENCY Retorna as propriedades do bg_currency no Jcss LABEL_BG_BALANCE_TOP (deprecated) Retorna as propriedades do bgBalanceTop no Jcss LABEL_BG_BALANCE_EQUAL (deprecated) Retorna as propriedades do bgBalanceEqual no Jcss LABEL_BG_BALANCE (deprecated) Retorna as propriedades do bgBalance no Jcss LABEL_BG_CURRENCY_BOTTOM (deprecated) Retorna as propriedades do bgCurrencyBottom no Jcss LABEL_BG_EQUAL_INPUT (deprecated) Retorna as propriedades do bgEqualInput no Jcss LABEL_BG_BIG_GENERAL (deprecated) Retorna as propriedades do bgBigGeneral no Jcss LABEL_BG_EQUAL_PART (deprecated) Retorna as propriedades do bgEqualPart no Jcss LABEL_IDLE_IMG Retorna as propriedades do idleImg no Jcss LABEL_IDLE_IMG2 (deprecated) Retorna as propriedades do idleImg2 no Jcss LABEL_IDLE_IMG3 (deprecated) Retorna as propriedades do idleImg3 no Jcss LABEL_IDLE_IMG_FEEDBACK Retorna as propriedades do idleImgFeedback no Jcss LABEL_MSG_LOW_BATTERY Retorna as propriedades do msgLowBattery no Jcss LABEL_AMOUNT (deprecated) Retorna as propriedades do amount no Jcss LABEL_TOKEN_TITLE (deprecated) Retorna as propriedades do token_title no Jcss LABEL_TOKEN_VALUE (deprecated) Retorna as propriedades do token_value no Jcss LABEL_DESCRIPTION_TITLE (deprecated) Retorna as propriedades do description_title no Jcss LABEL_DESCRIPTION (deprecated) Retorna as propriedades do description no Jcss LABEL_QTT_CURRENCY (deprecated) Retorna as propriedades do qtt_currency no Jcss LABEL_ITEM_VALUE (deprecated) Retorna as propriedades do item_value no Jcss LABEL_QUANTITY (deprecated) Retorna as propriedades do quantity no Jcss LABEL_DISCOUNT_CURRENCY (deprecated) Retorna as propriedades do discount_currency no Jcss LABEL_DISCOUNT_VALUE (deprecated) Retorna as propriedades do discount_value no Jcss LABEL_DISCOUNT_TITLE (deprecated) Retorna as propriedades do discount_title no Jcss LABEL_TITLE_SUMMARY (deprecated) Retorna as propriedades do discount_summary no Jcss LABEL_TITLE_payment (deprecated) Retorna as propriedades do discount_payment no Jcss LABEL_ITEM_TOTAL (deprecated) Retorna as propriedades do item_total no Jcss LABEL_ITEM_TOTAL_VALUE (deprecated) Retorna as propriedades do item_total_value no Jcss LABEL_ORDER_PRODUCT (deprecated) Retorna as propriedades do order_product no Jcss LABEL_ORDER_QTT (deprecated) Retorna as propriedades do order_qtt no Jcss LABEL_ORDER_VALUE (deprecated) Retorna as propriedades do order_value no Jcss LABEL_PAYMENT_TOTAL (deprecated) Retorna as propriedades do payment_total no Jcss LABEL_PAYMENT_TOTAL_AMOUNT (deprecated) Retorna as propriedades do payment_total_amount no Jcss LABEL_PAYMENT_PAID (deprecated) Retorna as propriedades do payment_paid no Jcss LABEL_PAYMENT_PAID_AMOUNT (deprecated) Retorna as propriedades do payment_paid_amount no Jcss LABEL_PAYMENT_BALANCE (deprecated) Retorna as propriedades do payment_paid_balance no Jcss LABEL_PAYMENT_BALANCE_AMOUNT (deprecated) Retorna as propriedades do payment_paid_balance_amount no Jcss LABEL_BG_SUMMARY (deprecated) Retorna as propriedades do bg_summary no Jcss LABEL_ORDER_TOTAL (deprecated) Retorna as propriedades do order_total no Jcss LABEL_ORDER_TOTAL_VALUE (deprecated) Retorna as propriedades do order_total_value no Jcss LABEL_PAYMENT_VALUE (deprecated) Retorna as propriedades do payment_value no Jcss LABEL_PAYMENT_VALUE_EQUAL (deprecated) Retorna as propriedades do payment_value_equal no Jcss LABEL_PAYMENT_METHOD_AMOUNT (deprecated) Retorna as propriedades do payment_method_amount no Jcss LABEL_BALANCE_LABEL (deprecated) Retorna as propriedades do balance_label no Jcss LABEL_BALANCE_LABEL_EQUAL (deprecated) Retorna as propriedades do balance_label_equal no Jcss LABEL_BALANCE_AMOUNT_LABEL (deprecated) Retorna as propriedades do balance_amount_label no Jcss LABEL_BALANCE_AMOUNT_LABEL_EQUAL (deprecated) Retorna as propriedades do balance_amount_label_equal no Jcss MEMO Retorna as propriedades do Memo no Jcss
getProperty¶
Style#getProperty(style, field, default_value, styleName)
Retorna o objeto ou valor referente à propriedade informada.
Parâmetros¶
- style - Objeto ao qual se quer retornar a propriedade
- field - propriedade a ser retornada
- default_value - valor que será retornado caso a propriedade não exista ou a função falhe ao retornar.
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna a propriedade podendo ser um novo objeto ou valor
Exemplo¶
use url Style "phui#components/style.wmlsc"; var style = Style#getProperties("image", "imgLogo", invalid); var area = Style#getProperty(style, "area", invalid, invalid);
getProperties¶
Style#getProperties(objtype, objname, styleName)
Retorna o valor referente ao objeto informado.
Parâmetros¶
- objtype - Tipo do objeto. Objeto root no arquivo JCSS do qual se deseja retornar as propriedades, o qual contém seus componentes logo abaixo hierarquicamente.
- objname - nome do componente abaixo do objeto root no arquivo JCSS
- styleName - nome do arquivo de estilo personalizado pelo usuário(pode ser atribuído invalid ou "").
Retorno¶
Retorna a propriedade podendo ser um novo objeto ou valor
Exemplo¶
use url Style "phui#components/style.wmlsc"; var style = Style#getProperties("image", "imgLogo", invalid); var area = Style#getProperty(style, "area", invalid, invalid);
getPropertyAlign¶
Style#getPropertyAlign(style, default_value, styleName)
obtém propriedades de alinhamento.
Parâmetros¶
- style - frame alvo
- default_value - valor padrão para o alinhamento.
- styleName - nome do arquivo de layout.
Retorno¶
retorna um String.
getAlignValue¶
Style#getAlignValue(value)
obtém o valor do alinhamento.
Parâmetros¶
- value - (left, right, top, bottom, center, vertical)
Retorno¶
Retorna o valor do alinhamento.
Arquivos de estilos¶
Os arquivos de estilos provê o layout dos componentes visualizados pelo usuário. É nele que definimos a fonte que será utlilizada, a cor de background de um componente, a area que ele vai ocupar o alinhamento, o nome do componente e etc.
Formato e exemplos¶
O arquivo de estilo deve ser escrito formato JSON (JavaScript Object Notation), vejamos um exemplo de sua notação:
{ "frame": { "background": { "color": 16777215 }, "area": { "x": 0, "y": 0, "w": 240, "h": 320 } } }O exemplo acima mostra a definição de um objeto "frame" onde é definido a cor de backuground em decimal (o padrão adotado é RGB 565), sua area onde "x" e "y" é posição do componente e "w" e "h" é a largura e altura respectivamente.
Arquivo JCSS¶
O SDK fornece ao desenvolvedor acesso ao nome dos componetes definidos no SDK através do pckage "phui#components/style.wmlsc", nesse package esta definido os componentes default da plataforma. Para maiores detalhes veja nossa suite de exemplos no SDK.
O Estilo¶
Deve ser armazenado em arquivo ascci e salvo na pasta da aplicação com o nome JCSS. Deve utilizar como estrutura o padrão json.
Exemplo de Estilo¶
{ "button": { "botaoExemplo": { "area": { "x": 20, "y": 20, "w": 90, "h": 50 }, "background": { "image": { "name": "BOT1", "code": 13, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } } }
Nome de componentes do arquivo JCSS¶
FONT_FG14¶
Style#FONT_FG14()
return font
"font": { "name": "FG14", "color": 12648705 }
FRAME¶
Style#FRAME()
return frame
"frame": { "background": { "color": 16777215 }
IMAGE_INPUT_CARD¶
Style#IMAGE_INPUT_CARD()
return inputCard
"image": { "inputCard": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 0, "w": 240, "h": 320 }, "name": "I011" } }
IMAGE_SEP_INFO¶
Style#IMAGE_SEP_INFO()
return sepinfo
"image": { "sepinfo": { "area": { "x": 3, "y": 80, "w": 240, "h": 50 }, "name": "SEP" } }
IMAGE_SEP_INFO_BOTTOM¶
Style#IMAGE_SEP_INFO_BOTTOM()
return sepinfoBottom
"image": { "sepinfoBottom": { "area": { "x": 3, "y": 260, "w": 240, "h": 15 }, "name": "SEP" } }
IMAGE_LOGO_MOBTEF¶
Style#IMAGE_LOGO_MOBTEF()
return logo_mobitef
"image": { "logo_mobitef": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 70, "w": 240, "h": 50 }, "name": "LOGO" } }
IMAGE_CONFIRMATION¶
Style#IMAGE_CONFIRMATION()
return confirmation
"image": { "confirmation": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 10, "w": 240, "h": 310 }, "name": "I010" } }
IMAGE_NOT_AUTHORIZED¶
Style#IMAGE_NOT_AUTHORIZED()
return notAuthorized
"image": { "notAuthorized": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 110, "w": 240, "h": 50 }, "name": "I007" } }
IMAGE_SHOW_AUTHORIZED¶
Style#IMAGE_SHOW_AUTHORIZED()
return noAuthorized
"notAuthorized": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 110, "w": 240, "h": 50 }, "name": "I007" }
IMAGE_SHOW_ERROR¶
Style#IMAGE_SHOW_ERROR()
return showError
"image": { "showError": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 110, "w": 240, "h": 50 }, "name": "I009" } }
IMAGE_SHOW_SUCCESS¶
Style#IMAGE_SHOW_SUCCESS()
return showSuccess
"image": { "showSuccess": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 110, "w": 240, "h": 50 }, "name": "I008" } }
IMAGE_PAYSTORE¶
Style#IMAGE_PAYSTORE()
return paystore
"image": { "paystore": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 30, "w": 240, "h": 150 }, "name": "I012" } }
IMAGE_SHOW_LOW_BATTERY¶
Style#IMAGE_SHOW_LOW_BATTERY()
return paystore
"image": { "showLowBattery": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 100, "w": 240, "h": 50 }, "name": "I013" } }
ANIMATION_LOADING¶
Style#ANIMATION_LOADING()
return loading
"animation": { "loading": { "align": [ "center", "vertical" ], "area": { "x": 0, "y": 110, "w": 240, "h": 50 }, "frequence": 1, "images": [ "I000", "I001", "I002", "I003", "I004", "I005", "I006" ] } }
LABEL_INFO_TITLE¶
Style#LABEL_INFO_TITLE()
return lbinfoTitle
"label": { "lbinfoTitle": { "area": { "x": 8, "y": 60, "w": 240, "h": 20 }, "font": { "color": 0, "name": "FG18" }, "align": ["left", "vertical"], "backGround": { "color": 16777215 } } }
LABEL_INFO_CENTER¶
Style#LABEL_INFO_CENTER()
return lbinfoCenter
"label": { "lbinfoCenter": { "area": { "x": 0, "y": 0, "w": 240, "h": 13 }, "align": ["center", "vertical"], "font": { "name": "FG14", "color": 0 } } }
LABEL_INFO_LEFT¶
Style#LABEL_INFO_LEFT()
return lbinfoLeft
"label": { "lbinfoLeft": { "area": { "x": 0, "y": 0, "w": 130, "h": 13 }, "font": { "name": "FG14", "color": 0 }, "align": ["left", "vertical"] } }
LABEL_INFO_VALUE_LEFT¶
Style#LABEL_INFO_VALUE_LEFT()
return lbinfoValueLeft
"label": { "lbinfoValueLeft": { "area": { "x": 0, "y": 0, "w": 230, "h": 13 }, "font": { "name": "FG16", "color": 0 }, "align": ["right", "vertical"] } }
LABEL_INFO_RIGHT¶
Style#LABEL_INFO_RIGHT()
return lbinfoRight
"label": { "lbinfoRight": { "area": { "x": 0, "y": 0, "w": 95, "h": 13 }, "align": ["right", "vertical"], "font": { "name": "FG16", "color": 0 } } }
LABEL_MESSAGE¶
Style#LABEL_MESSAGE()
return message
"label": { "message": { "area": { "x": 0, "y": 30, "w": 240, "h": 320 }, "align": [ "center", "vertical" ], "font": { "name": "FG16", "color": 12648705 } } }
LABEL_TITLE_ERROR_MSG¶
Style#LABEL_TITLE_ERROR_MSG()
return titleErrorMsg
"label": { "titleErrorMsg": { "area": { "x": 0, "y": 22, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "bottom" ] } }
LABEL_TITLE¶
Style#LABEL_TITLE()
return title
"label": { "title": { "area": { "x": 0, "y": 32, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_TITLE_FEEDBACK¶
Style#LABEL_TITLE_FEEDBACK()
return titleFeedBack
"label": { "titleFeedBack": { "area": { "x": 0, "y": 22, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_MESSAGE_FEEDBACK¶
Style#LABEL_MESSAGE_FEEDBACK()
return messageFeedback
"label": { "messageFeedBack": { "area": { "x": 0, "y": 215, "w": 240, "h": 55 }, "background": { "color": 16777215 }, "font": { "color": 0, "name": "FG16" }, "align": [ "center" ] } }
LABEL_SUBTITLE¶
Style#LABEL_SUBTITLE()
return subtitle
"label": { "subtitle": { "area": { "x": 0, "y": 95, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "center", "vertical" ] } }
LABEL_HINT¶
Style#LABEL_HINT()
return hint
"label": { "hint": { "area": { "x": 0, "y": 256, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center" ] } }
LABEL_AC_SUBTITLE¶
Style#LABEL_AC_SUBTITLE()
return AcSubtitle
"label": { "AcSubtitle": { "area": { "x": 0, "y": 120, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "center", "vertical" ] } }
LABEL_SUBTITLE_CUSTOM¶
Style#LABEL_SUBTITLE_CUSTOM()
return subtitle_custom
"label": { "subtitle_custom": { "area": { "x": 0, "y": 170, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "center", "vertical" ] } }
LABEL_HEADING¶
Style#LABEL_HEADING()
return lbHeading
"label": { "lbHeading": { "area": { "x": 0, "y": 10, "w": 240, "h": 78 }, "font": { "color": 0, "name": "FG16" }, "align": [ "center", "vertical" ] } }
LABEL_TITLE_INPUT¶
Style#LABEL_TITLE_INPUT()
return titleInput
"label": { "titleInput": { "area": { "x": 0, "y": 32, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_TITLE_AC_INPUT¶
Style#LABEL_TITLE_AC_INPUT()
return titleAcInput
"label": { "titleAcInput": { "area": { "x": 0, "y": 32, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_TITLE_INPUT_CUSTOM¶
Style#LABEL_TITLE_INPUT_CUSTOM()
return titleInputCustom
"label": { "titleInputCustom": { "area": { "x": 0, "y": 82, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_PAGED_TITLE_MENU¶
Style#LABEL_PAGED_TITLE_MENU()
return pagedTitleMenu
"label": { "pagedTitleMenu": { "backGround": { "color": 16777215 }, "area": { "x": 185, "y": 27, "w": 50, "h": 33 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "right", "vertical" ] } }
LABEL_TITLE_MENU¶
Style#LABEL_TITLE_MENU()
return titleMenu
"label": { "titleMenu": { "area": { "x": 5, "y": 27, "w": 215, "h": 33 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "left", "vertical" ] } }
LABEL_ICON_MENU_TITLE¶
Style#LABEL_ICON_MENU_TITLE()
return icon_menuTitle
"label": { "icon_menuTitle": { "area": { "x": 5, "y": 27, "w": 215, "h": 33 }, "font": { "color": 0, "name": "FG14" }, "align": [ "center", "vertical" ] } }
LABEL_COUNT_MENU_LABEL¶
Style#LABEL_COUNT_MENU_LABEL()
return count_menuLabel
"label": { "count_menuLabel": { "area": { "x": 180, "y": 30, "w": 50, "h": 33 }, "font": { "color": 16777215, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_PRESENTATION¶
Style#LABEL_PRESENTATION()
return presentation
"label": { "presentation": { "area": { "x": 0, "y": 140, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_IDLE_MSG¶
Style#LABEL_IDLE_MSG()
return idleMsg
"label": { "idleMsg": { "area": { "x": 0, "y": 160, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ] } }
LABEL_IDLE_MSG2¶
Style#LABEL_IDLE_MSG2()
return idleMsg2
"label": { "idleMsg2": { "area": { "x": 0, "y": 135, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ] } }
LABEL_IDLE_MSG3¶
Style#LABEL_IDLE_MSG3()
return idleMsg3
"label": { "idleMsg3": { "area": { "x": 0, "y": 115, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ] } }
LABEL_CURRENCY¶
Style#LABEL_CURRENCY()
return currency
"label": { "currency": { "area": { "x": 15, "y": 170, "w": 200, "h": 50 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "right", "vertical" ] } }
LABEL_CURRENCY_CUSTOM¶
Style#LABEL_CURRENCY_CUSTOM()
return currency_custom
"label": { "currency_custom": { "area": { "x": 15, "y": 220, "w": 200, "h": 50 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "right", "vertical" ] } }
LABEL_BG_CURRENCY¶
Style#LABEL_BG_CURRENCY()
return bgCurrency
"label": { "bgCurrency": { "background": { "image": { "name": "BG05", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 115, "w": 240, "h": 50 } } }
LABEL_BG_BALANCE_TOP¶
Style#LABEL_BG_BALANCE_TOP()
return bgBalanceTop
"label": { "bgBalanceTop": { "background": { "image": { "name": "BG01", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 65, "w": 240, "h": 50 } } }
LABEL_BG_BALANCE_EQUAL¶
Style#LABEL_BG_BALANCE_EQUAL()
return bgBalanceEqual
"label": { "bgBalanceEqual": { "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 85, "w": 240, "h": 50 } } }
LABEL_BG_BALANCE¶
Style#LABEL_BG_BALANCE()
return bgBalance
"label": { "bgBalance": { "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 115, "w": 240, "h": 50 } } }
LABEL_BG_CURRENCY_BOTTOM¶
Style#LABEL_BG_CURRENCY_BOTTOM()
return bgCurrencyBottom
"label": { "bgCurrencyBottom": { "background": { "image": { "name": "BG05", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 165, "w": 240, "h": 50 } } }
LABEL_BG_EQUAL_INPUT¶
Style#LABEL_BG_EQUAL_INPUT()
return bgEqualInput
"label": { "bgEqualInput": { "background": { "image": { "name": "BG04", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 165, "w": 240, "h": 50 } } }
LABEL_BG_BIG_GENERAL¶
Style#LABEL_BG_BIG_GENERAL()
return bgBigGeneral
"label": { "bgBigGeneral": { "background": { "image": { "name": "BG10", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 100, "w": 240, "h": 50 } } }
LABEL_BG_EQUAL_PART¶
Style#LABEL_BG_EQUAL_PART()
return bgEqualPart
"label": { "bgEqualPart": { "background": { "image": { "name": "BG08", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 135, "w": 240, "h": 50 } } }
LABEL_IDLE_IMG¶
Style#LABEL_IDLE_IMG()
return idleImg
"label": { "idleImg": { "background": { "image": { "name": "LOGO", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 90, "w": 240, "h": 75 } } }
LABEL_IDLE_IMG2¶
Style#LABEL_IDLE_IMG2()
return idleImg2
"label": { "idleImg2": { "background": { "image": { "name": "LOGO", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 65, "w": 240, "h": 75 } } }
LABEL_IDLE_IMG3¶
Style#LABEL_IDLE_IMG3()
return idleImg3
"label": { "idleImg3": { "background": { "image": { "name": "LOGO", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 45, "w": 240, "h": 75 } } }
LABEL_IDLE_IMG_FEEDBACK¶
Style#LABEL_IDLE_IMG_FEEDBACK()
return idleImgFeedback
"label": { "idleImgFeedback": { "background": { "image": { "name": "LOGO", "align": [ "center", "vertical" ] } }, "area": { "x": 0, "y": 50, "w": 240, "h": 75 } } }
LABEL_MSG_LOW_BATTERY¶
Style#LABEL_MSG_LOW_BATTERY()
return msgLowBattery
"label": { "msgLowBattery": { "area": { "x": 4, "y": 185, "w": 235, "h": 78 }, "font": { "color": 0, "name": "FG14" }, "align": [ "center", "vertical" ] } } }
LABEL_AMOUNT¶
Style#LABEL_AMOUNT()
return amount
"label": { "amount": { "area": { "x": 15, "y": 115, "w": 210, "h": 50 }, "align": [ "center", "vertical" ] } }
LABEL_TOKEN_TITLE¶
Style#LABEL_TOKEN_TITLE()
return token_title
"label": { "token_title": { "area": { "x": 0, "y": 150, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "center", "vertical" ], "background": { "image": { "name": "BG08", "align": [ "center", "vertical" ] } } } }
LABEL_TOKEN_VALUE¶
Style#LABEL_TOKEN_VALUE()
return token_value
"label": { "token_value": { "area": { "x": 0, "y": 200, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG26" }, "align": [ "center", "vertical" ] } }
LABEL_DESCRIPTION_TITLE¶
Style#LABEL_DESCRIPTION_TITLE()
return description_title
"label": { "description_title": { "area": { "x": 0, "y": 90, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ], "background": { "image": { "name": "BG08", "align": [ "center", "vertical" ] } } } }
LABEL_DESCRIPTION¶
Style#LABEL_DESCRIPTION()
return description
"label": { "description": { "area": { "x": 20, "y": 115, "w": 200, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ] } }
LABEL_QTT_CURRENCY¶
Style#LABEL_QTT_CURRENCY()
return qtt_currency
"label": { "qtt_currency": { "area": { "x": 20, "y": 193, "w": 200, "h": 52 }, "font": { "color": 12648705, "name": "FG20" }, "align": [ "left", "vertical" ] } }
LABEL_ITEM_VALUE¶
Style#LABEL_ITEM_VALUE()
return item_value
"label": { "item_value": { "area": { "x": 12, "y": 193, "w": 205, "h": 52 }, "font": { "color": 12648705, "name": "FG20" }, "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "align": [ "right", "vertical" ] } }
LABEL_QUANTITY¶
Style#LABEL_QUANTITY()
return quantity
"label": { "quantity": { "area": { "x": 20, "y": 242, "w": 220, "h": 50 }, "font": { "color": 12648705, "name": "FG20" }, "align": [ "left", "vertical" ] } }
LABEL_DISCOUNT_CURRENCY¶
Style#LABEL_DISCOUNT_CURRENCY()
return discount_currency
"label": { "discount_currency": { "area": { "x": 20, "y": 138, "w": 200, "h": 52 }, "font": { "color": 12648705, "name": "FG20" }, "align": [ "left", "vertical" ] } }
LABEL_DISCOUNT_VALUE¶
Style#LABEL_DISCOUNT_VALUE()
return discount_value
"label": { "discount_value": { "area": { "x": 13, "y": 138, "w": 205, "h": 52 }, "font": { "color": 12648705, "name": "FG20" }, "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "align": [ "right", "vertical" ] } }
LABEL_DISCOUNT_TITLE¶
Style#LABEL_DISCOUNT_TITLE()
return discount_title
"label": { "discount_title": { "area": { "x": 0, "y": 190, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ], "background": { "image": { "name": "BG03", "align": [ "center", "vertical" ] } } } }
LABEL_TITLE_SUMMARY¶
Style#LABEL_TITLE_SUMMARY()
return title_summary
"label": { "title_summary": { "area": { "x": 0, "y": 90, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "center", "vertical" ], "background": { "image": { "name": "BG09", "align": [ "center", "vertical" ] } } } }
LABEL_TITLE_PAYMENT¶
Style#LABEL_TITLE_PAYMENT()
return title_payment
"label": { "title_payment": { "area": { "x": 0, "y": 32, "w": 240, "h": 78 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_ITEM_TOTAL¶
Style#LABEL_ITEM_TOTAL()
return item_total
"label": { "item_total": { "area": { "x": 18, "y": 204, "w": 220, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_ITEM_TOTAL_VALUE¶
Style#LABEL_ITEM_TOTAL_VALUE()
return item_total_value
"label": { "item_total_value": { "area": { "x": 13, "y": 204, "w": 208, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "align": [ "right", "vertical" ] } }
LABEL_ORDER_PRODUCT¶
Style#LABEL_ORDER_PRODUCT()
return order_product
"label": { "order_product": { "area": { "x": 13, "y": 70, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "left", "vertical" ] } }
LABEL_ORDER_QTT¶
Style#LABEL_ORDER_QTT()
return order_qtt
"label": { "order_qtt": { "area": { "x": 100, "y": 70, "w": 240, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "left", "vertical" ] } }
LABEL_ORDER_VALUE¶
Style#LABEL_ORDER_VALUE()
return order_value
"label": { "order_value": { "area": { "x": 13, "y": 70, "w": 210, "h": 50 }, "font": { "color": 12648705, "name": "FG14" }, "align": [ "right", "vertical" ] } }
LABEL_PAYMENT_TOTAL¶
Style#LABEL_PAYMENT_TOTAL()
return payment_total
"label": { "payment_total": { "area": { "x": 15, "y": 100, "w": 210, "h": 35 }, "background": { "image": { "name": "BG10", "align": [ "center", "vertical" ] } }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_PAYMENT_TOTAL_AMOUNT¶
Style#LABEL_PAYMENT_TOTAL_AMOUNT()
return payment_total_amount
"label": { "payment_total_amount": { "area": { "x": 15, "y": 117, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "right", "vertical" ] } }
LABEL_PAYMENT_PAID¶
Style#LABEL_PAYMENT_PAID()
return payment_paid
"label": { "payment_paid": { "area": { "x": 15, "y": 135, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_PAYMENT_PAID_AMOUNT¶
Style#LABEL_PAYMENT_PAID_AMOUNT()
return payment_paid_amount
"label": { "payment_paid_amount": { "area": { "x": 15, "y": 152, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "right", "vertical" ] } }
LABEL_PAYMENT_BALANCE¶
Style#LABEL_PAYMENT_BALANCE()
return payment_balance
"label": { "payment_balance": { "area": { "x": 15, "y": 170, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_PAYMENT_BALANCE_AMOUNT¶
Style#LABEL_PAYMENT_BALANCE_AMOUNT()
return payment_balance_amount
"label": { "payment_balance_amount": { "area": { "x": 15, "y": 187, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "right", "vertical" ] } }
LABEL_BG_SUMMARY¶
Style#LABEL_BG_SUMMARY()
return bg_summary
"label": { "bg_summary": { "background": { "image": { "name": "BG08", "align": [ "center", "vertical" ] } }, "area": { "x": 13, "y": 103, "w": 210, "h": 35 } } }
LABEL_ORDER_TOTAL¶
Style#LABEL_ORDER_TOTAL()
return order_total
"label": { "order_total": { "area": { "x": 18, "y": 208, "w": 220, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_ORDER_TOTAL_VALUE¶
Style#LABEL_ORDER_TOTAL_VALUE()
return order_total_value
"label": { "order_total_value": { "area": { "x": 13, "y": 208, "w": 210, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "background": { "image": { "name": "BG06", "align": [ "center", "vertical" ] } }, "align": [ "right", "vertical" ] } }
LABEL_PAYMENT_VALUE¶
Style#LABEL_PAYMENT_VALUE()
return payment_value
"label": { "payment_value": { "area": { "x": 13, "y": 100, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_PAYMENT_VALUE_EQUAL¶
Style#LABEL_PAYMENT_VALUE_EQUAL()
return payment_value_equal
"label": { "payment_value_equal": { "area": { "x": 13, "y": 135, "w": 210, "h": 35 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "center", "vertical" ] } }
LABEL_PAYMENT_METHOD_AMOUNT¶
Style#LABEL_PAYMENT_METHOD_AMOUNT()
return payment_method_amount
"label": { "payment_method_amount": { "area": { "x": 15, "y": 200, "w": 205, "h": 35 }, "font": { "color": 12648705, "name": "FG18" }, "align": [ "right", "vertical" ] } }
LABEL_BALANCE_LABEL¶
Style#LABEL_BALANCE_LABEL()
return balance_label
"label": { "balance_label": { "area": { "x": 15, "y": 115, "w": 205, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_BALANCE_LABEL_EQUAL¶
Style#LABEL_BALANCE_LABEL_EQUAL()
return balance_label_equal
"label": { "balance_label_equal": { "area": { "x": 15, "y": 85, "w": 205, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "left", "vertical" ] } }
LABEL_BALANCE_AMOUNT_LABEL¶
Style#LABEL_BALANCE_AMOUNT_LABEL()
return balance_amount_label
"label": { "balance_amount_label": { "area": { "x": 15, "y": 115, "w": 205, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "right", "vertical" ] } }
LABEL_BALANCE_AMOUNT_LABEL_EQUAL¶
Style#LABEL_BALANCE_AMOUNT_LABEL_EQUAL()
return balance_amount_label_equal
"label": { "balance_amount_label_equal": { "area": { "x": 15, "y": 85, "w": 205, "h": 50 }, "font": { "color": 12648705, "name": "FG16" }, "align": [ "right", "vertical" ] } }
MEMO¶
Style#MEMO()
return memo
"memo": { "font": { "name": "FG14", "color": 12648705 }, "align": [ "center" ], "area": { "w": 200, "h": 160, "x": 20, "y": 80 } }
MEMO_ORDER_SUMMARY¶
Style#MEMO_ORDER_SUMMARY()
return order_summary
"memo": { "order_summary": { "lines": { "align": ["left"] }, "align": ["center", "top"], "area": { "w": 200, "h": 90, "x": 18, "y": 113 } } }
MEMO_PAYMENT_SUMMARY¶
Style#MEMO_PAYMENT_SUMMARY()
return payment_summary
"memo": { "payment_summary": { "area": { "x": 13, "y": 100, "w": 210, "h": 130 }, "align": ["center", "top"], "lines": { "align": ["center", "vertical"] }, "font": { "color": 12648705, "name": "CO16" }, "background": { "image": { "name": "BG05", "align": [ "center", "vertical" ] } } } }
MEMO_ITEM_SUMMARY¶
Style#MEMO_ITEM_SUMMARY()
return item_summary
"memo": { "item_summary": { "lines": { "align": ["left"] }, "align": ["center", "vertical"], "area": { "w": 200, "h": 180, "x": 18, "y": 80 } } }
MEMO_MEMO_MSG¶
Style#MEMO_MEMO_MSG()
return memoMsg
"memo": { "memoMsg": { "lines": { "align": ["center"] }, "align": ["center", "bottom"], "area": { "w": 200, "h": 320, "x": 20, "y": 220 } } }
MEMO_CENTER_MEMO¶
Style#MEMO_CENTER_MEMO()
return centerMemo
"memo": { "centerMemo": { "align": ["center", "vertical"], "area": { "w": 200, "h": 160, "x": 21, "y": 80 } } }
MEMO_MEMO_INFO¶
Style#MEMO_MEMO_INFO()
return memoInfo
"memo": { "memoInfo": { "align": ["center", "top"], "lines": { "align": ["left"] } } }
MEMO_SHOW_MEMO¶
Style#MEMO_SHOW_MEMO()
return showMemo
"memo": { "showMemo": { "align": ["left"] } }
MENU¶
Style#MENU()
return menu
"menu": { "area": { "x": 5, "y": 55, "w": 230, "h": 220 }, "font": { "color": 12648705, "name": "FG14" }, "itemColors": { "selectedBackgroundColor": 14273241, "unselectedBackgroundColor": 15112601, "selectedFontColor": 12648705, "unselectedFontColor": 12648705 }, "menuImages": { "selectedItemImage": "MNON", "selectedItemImageTextWidth": 200, "unselectedItemImage": "MN", "unselectedItemImageTextWidth": 200 }, "itensPerScreen": 5, "upperCase": true }
FIELD¶
Style#FIELD()
return field
"field": { "color": 0, "font": { "name": "FG18#FG16", "color": 12648705 }, "area": { "x": 14, "y": 150, "w": 205, "h": 50 }, "background": { "image": { "name": "BG02", "align": [ "left", "vertical" ] } }, "align": [ "right", "vertical" ] }
FIELD_PASSWORD¶
Style#FIELD_PASSWORD()
return password
"field": { "password": { "font": { "name": "FG24", "color": 12648705 }, "hiddenChar": "FHCH" } }
FIELD_PASSWORD2¶
Style#FIELD_PASSWORD2()
return password2
"field": { "password2": { "font": { "name": "FG24", "color": 12648705 }, "hiddenChar": "FHCH", "align": [ "left", "vertical" ], "area": { "x": 20, "y": 215, "w": 205, "h": 50 }, "background": {} } }
FIELD_AC_INPUT¶
Style#FIELD_AC_INPUT()
return acInput
"field": { "acInput": { "font": { "name": "FG24", "color": 12648705 }, "area": { "x": 13, "y": 120, "w": 215, "h": 100 }, "background": { "image": { "name": "BG04", "align": [ "center", "vertical" ] } }, "align": [ "center", "vertical" ] } }
FIELD_CURRENCY¶
Style#FIELD_CURRENCY()
return currency
"field": { "currency": { "font": { "name": "FG26#FG20", "color": 12648705 }, "background": {}, "area": { "x": 0, "y": 200, "w": 215, "h": 50 }, "align": [ "right", "vertical" ] } }
FIELD_CURRENCY_CUSTOM¶
Style#FIELD_CURRENCY_CUSTOM()
return currency_custom
"field": { "currency_custom": { "font": { "name": "FG26", "color": 12648705 }, "background": {}, "area": { "x": 0, "y": 250, "w": 215, "h": 50 }, "align": [ "right", "vertical" ] } }
FIELD_EQUAL_PART_CUSTOM¶
Style#FIELD_EQUAL_PART_CUSTOM()
return equal_part_custom
"field": { "equal_part_custom": { "font": { "name": "FG26", "color": 12648705 }, "background": {}, "area": { "x": 0, "y": 215, "w": 215, "h": 50 }, "align": [ "right", "vertical" ] } }
FIELD_QTT_INPUT¶
Style#FIELD_QTT_INPUT()
return qtt_input
"field": { "qtt_input": { "area": { "x": 12, "y": 216, "w": 205, "h": 100 }, "font": { "name": "FG20", "color": 12648705 }, "background": { "image": { "name": "BG01", "align": [ "center", "vertical" ] } }, "align": [ "right", "vertical" ] } }
FIELD_DISCOUNT_INPUT¶
Style#FIELD_DISCOUNT_INPUT()
return discount_input
"field": { "discount_input": { "area": { "x": 12, "y": 216, "w": 205, "h": 100 }, "font": { "name": "FG20", "color": 32768 }, "background": {}, "align": [ "right", "vertical" ] } }
CARD¶
Style#CARD()
return card
"card": { "title": { "area": { "x": 0, "y": 37, "w": 240, "h": 78 }, "align": [ "center", "vertical" ] }, "message": { "area": { "x": 0, "y": 180, "w": 240, "h": 140 }, "align": [ "center", "vertical" ] } }
PINPAD¶
Style#PINPAD()
return pinpad
"pinpad": { "entry" : { "position" : { "x" : 20, "y" : 230}, "colors" : { "bg" : 58579, "fg" : 49152}, "specificFont": "pp16" }, "font": { "color": 12648705, "name" : "FG24" }, "title": { "font": { "color": 12648705, "name" : "FG20" }, "area": { "x": 0, "y": 37, "w": 240, "h": 78 }, "align": [ "center", "vertical" ] }, "subtitle": { "font": { "color": 12648705, "name" : "FG18" }, "area": { "x": 0, "y": 180, "w": 240, "h": 98 }, "position" : { "x" : 20, "y" : 20}, "background" : { "image" : { "name" : "PWDS", "align": [ "center", "vertical" ] }, "align": [ "center", "vertical" ] }, "align": [ "left", "top" ] }, "currency" : { "font": { "color": 12648705, "name" : "FG20" }, "area": { "x": 0, "y": 115, "w": 240, "h": 52 }, "position" : { "x" : 20, "y" : 5}, "align": [ "left", "bottom" ] }, "value" : { "area": { "x": 0, "y": 115, "w": 240, "h": 52 }, "position" : { "x" : 20, "y" : 5}, "background" : { "image" : { "name" : "PWDE", "align": [ "center", "vertical" ] }, "align": [ "center", "vertical" ] }, "align": [ "right", "bottom" ], "font": { "color": 12648705, "name" : "FG18" } } }
STATUS¶
Style#STATUS()
return status
"status": { "area": { "x": 0, "y": 0, "w": 240, "h": 27 }, "background": { "color": 12648705 }, "font": { "name": "FG10", "color": 16777215 }, "battery": { "position": { "x": 1, "y": 3 }, "icons": { "name": "SBTT", "color": 16777215 }, "align": [ "right", "top" ], "charging": { "position": { "x": 0, "y": 4 } }, "percentage": { "position": { "x": 36, "y": 11 } } }, "signal": { "position": { "x": 0, "y": 0 }, "icons": { "name": "SBAT", "color": 16777215 }, "text": { "position": { "x": 25, "y": 6 }, "align": [ "left", "bottom" ] }, "align": [ "left", "bottom" ] }, "device": { "icons": { "name": "SBDV" }, "stsColors": { "not_present": 16711680, "present": 16777215, "connected": 65280, "sckt_connected": 255 }, "align": [ "left", "bottom" ], "position": { "x": 60, "y": 0 } }, "clock": { "align": [ "left", "top" ], "position": { "x": 95, "y": 11 } }, "provider": { "icons": { "name": "SBOP", "color": 16777215 }, "align": [ "right", "top" ], "position": { "x": 65, "y": 2 } } }
NAVIGATION¶
Style#NAVIGATION()
return navigation
"navigation": { "area": { "x": 5, "y": 275, "w": 230, "h": 40 }, "down": { "background": { "image": { "name": "NAVD", "code": 3, "align": [ "right", "vertical" ] } } }, "downdisabled": { "background": { "image": { "name": "NVDD", "code": 0, "align": [ "right", "vertical" ] } } }, "up": { "position": { "x": 60, "y": 0 }, "background": { "image": { "name": "NAVU", "code": 4, "align": [ "right", "vertical" ] } } }, "updisabled": { "position": { "x": 60, "y": 0 }, "background": { "image": { "name": "NVUD", "code": 0, "align": [ "right", "vertical" ] } } } }
KEYBOARD¶
Style#KEYBOARD()
return keyboard
"keyboard" : { "icons": { "name": "KEYB", "color": 12648705 }, "font": { "name": "FG18", "color": 12648705 }, "area": { "x": 10, "y": 200, "w": 220, "h": 120 } }
BUTTON¶
Style#BUTTON()
return button
"button": { "font": { "name": "FG14", "color": 12648705 } }
BUTTON_EXIT¶
Style#BUTTON_EXIT()
return exit
"button": { "exit": { "area": { "x": 5, "y": 275, "w": 90, "h": 40 }, "background": { "image": { "name": "BTN", "code": 10, "align": [ "center", "vertical" ] } }, "label": { "visible": true, "upperCase": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE1¶
Style#BUTTON_BT_IDLE1()
return btIdle1
"button": { "btIdle1": { "area": { "x": 20, "y": 165, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 13, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE2¶
Style#BUTTON_BT_IDLE2()
return btIdle2
"button": { "btIdle2": { "area": { "x": 130, "y": 165, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 16, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE3_MENU¶
Style#BUTTON_BT_IDLE3_MENU()
return btIdle3Menu
"button": { "btIdle3Menu": { "area": { "x": 20, "y": 215, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 13, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE4_FUNC¶
Style#BUTTON_BT_IDLE4_FUNC()
return btIdle4Func
"button": { "btIdle4Func": { "area": { "x": 130, "y": 215, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 16, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE3¶
Style#BUTTON_BT_IDLE3()
return btIdle3
"button": { "btIdle3": { "area": { "x": 20, "y": 215, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 6, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE4¶
Style#BUTTON_BT_IDLE4()
return btIdle4
"button": { "btIdle4": { "area": { "x": 130, "y": 215, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 10, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE5¶
Style#BUTTON_BT_IDLE5()
return btIdle5
"button": { "btIdle5": { "area": { "x": 20, "y": 265, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 5, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_IDLE6¶
Style#BUTTON_BT_IDLE6()
return btIdle6
"button": { "btIdle6": { "area": { "x": 130, "y": 265, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 15, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_MENU¶
Style#BUTTON_BT_MENU()
return btMenu
"button": { "btMenu": { "area": { "x": 20, "y": 230, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 13, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "upperCase": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_APP¶
Style#BUTTON_BT_APP()
return btApp
"button": { "btApp": { "area": { "x": 130, "y": 230, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "upperCase": false, "align": [ "center", "vertical" ] } } }
BUTTON_BT_OK_LOW_BATTERY¶
Style#BUTTON_BT_OK_LOW_BATTERY()
return btOkLowBattery
"button": { "btOkLowBattery": { "area": { "x": 0, "y": 270, "w": 240, "h": 50 }, "background": { "image": { "name": "BTN", "code": 13, "align": [ "center", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_FUNC¶
Style#BUTTON_BT_FUNC()
return btFunc
"button": { "btFunc": { "area": { "x": 130, "y": 230, "w": 90, "h": 50 }, "background": { "image": { "code": 16, "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "upperCase": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_FUNC_MENU¶
Style#BUTTON_BT_FUNC_MENU()
return btFuncMenu
"button": { "btFuncMenu": { "area": { "x": 20, "y": 230, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 14, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "upperCase": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_YES¶
Style#BUTTON_BT_YES()
return btYes
"button": { "btYes": { "area": { "x": 13, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 13, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_NO¶
Style#BUTTON_BT_NO()
return btNo
"button": { "btNo": { "area": { "x": 137, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "code": 27, "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_LEFT¶
Style#BUTTON_BT_LEFT()
return btLeft
"button": { "btLeft": { "area": { "x": 13, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 27, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_RIGHT¶
Style#BUTTON_BT_RIGHT()
return btRight
"button": { "btRight": { "area": { "x": 137, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "code": 13, "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_PRT¶
Style#BUTTON_BT_PRT()
return btPrt
"button": { "btPrt": { "area": { "x": 137, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "code": 16, "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_OP1¶
Style#BUTTON_BT_OP1()
return btOp1
"button": { "btOp1": { "area": { "x": 13, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "name": "BTN", "code": 49, "align": [ "left", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
BUTTON_BT_OP2¶
Style#BUTTON_BT_OP2()
return btOp2
"button": { "btOp2": { "area": { "x": 137, "y": 255, "w": 90, "h": 50 }, "background": { "image": { "code": 50, "name": "BTN", "align": [ "right", "vertical" ] } }, "label": { "visible": true, "align": [ "center", "vertical" ] } } }
COUNTDOWN¶
Style#COUNTDOWN()
return countdown
"countdown": { "token_time": { "area": { "x": 0, "y": 90, "w": 240, "h": 51 }, "align": [ "center", "vertical" ], "font": { "name": "FG26", "color": 12648705 }, "background": { "image": { "name": "BG07", "align": [ "center", "vertical" ] } } } }
CROLL_LABEL¶
Style#SCROLL_LABEL()
return scroll_label
"scroll_label": { "token_message": { "area": { "x": 20, "y": 280, "w": 200, "h": 50 }, "align": [ "center", "vertical" ] } }
PROGRESS_PHDM¶
Style#PROGRESS_PHDM()
return phdm
"progress": { "phdm": { "area": { "x": 20, "y": 290, "w": 200, "h": 25 }, "image": { "area": { "x": 20, "y": 290, "w": 200, "h": 25 }, "backColor": 15198183, "foreColor": 4304053 }, "text": { "area": { "x": 20, "y": 292, "w": 200, "h": 25 }, "align": [ "center", "vertical" ], "font": { "color": 6038659, "name": "FG14" } } } }Exemplo¶
use url Style "phui#components/style.wmlsc"; var btSair = Button#create(Style#BUTTON_EXIT(), "sair", invalid);
Arquivo de estilo customizado¶
O Desenvolvedor pode criar seus próprios componentes e definições de layout, basta criar um arquivo de estilo na pasta RES do projeto, esse arquivo deve conter até 4 caracteres sem extenção.
Exemplo¶
{ "button": { "font": { "name": "FG14", "color": 12648705 }, "exit": { "area": { "x": 5, "y": 275, "w": 90, "h": 40 }, "background": { "image": { "name": "BTN", "code": 10, "align": [ "center", "vertical" ] } }, "label": { "visible": true, "upperCase": true, "align": [ "center", "vertical" ] } }, "bt1": { "area": { "x": 75, "y": 125, "w": 90, "h": 40 }, "background": { "image": { "name": "BTN", "code": 130, "align": [ "center", "vertical"] } }, "label": { "visible": true, "align": [ "center", "vertical"] } }, "bt2": { "area": { "x": 75, "y": 175, "w": 90, "h": 40 }, "background": { "image": { "name": "BTN", "code": 131, "align": [ "center", "vertical"] } }, "label": { "visible": true, "align": [ "center", "vertical"] } } }Considere que o arquivo acima foi salvo como "MCSS" na pasta RES do nosso projeto, vamos utiliza-lo em nosso script:
//criando os componentes, passando como parametro o nome do arquivo de estilo que tem suas propriedades var bt01 = Button#create("bt1", "button01", "MCSS"); var bt02 = Button#create("bt2", "button02", "MCSS"); //perceba que o button "exit" existe no arquivo JCSS, mas esta sendo sobreescrito no arquivo MCSS var btSair = Button#create("exit","sair", "MCSS");
Timer¶
| package://phui#components/timer.wmlsc |
|---|
Este módulo fornece funções para capturas interativas diversas.
Sumário¶
Função Descrição create Cria um timer. setTimer Adiciona um timer a um componente. reset Adiciona um timer a um componente.
create¶
Timer#create(fname, timeout, resetTimeoutOnKey)
Implementação de criação de timer para gerenciamento de evento.
Parâmetros¶
- fname - string que representa o nome do componente;
- timeout - inteiro em milesegundos que representa o timeout do compomente;
- resetTimeoutOnKey - boleano que reseta o timeout de acordo alguma ação do usuário;
Retorno¶
true ou falso
Exemplo:¶
use url Timer "package://phui#components/timer.wmlsc"; use url Frame "package://phui#components/frame.wmlsc"; use url Label "package://phui#components/label.wmlsc"; use url Status "package://phui#components/status.wmlsc"; use url Style "package://phui#components/style.wmlsc"; extern function test() { var frame = Frame#create("frame", ""); var label = Label#create(Style#LABEL_MESSAGE(), "Olá mundo!", invalid); Frame#add(frame, Status#create("status", "")); Frame#add(frame, label); Frame#add(frame, Timer#create("timer", 5000, true)); Frame#show(frame); }Exemplo de saída em tela:
Olá mundo!
setTimer¶
Timer#setTimer(frame, timeout)
Adiciona um timer a um componente.
Parâmetros¶
- frame - componente alvo;
- timeout - inteiro em milesegundos que representa o timeout do componente;
Retorno¶
Nenhum
reset¶
Timer#reset(component)
Reseta o timer de um componente.
Parámetros¶
- component - componente alvo;
Retorno¶
Nenhum
Tbitmap¶
| url package://libs#ui/tbitmap.wmlsc |
|---|
- Biblioteca para trabalhar com imagens bitmap.
Constantes¶
Constante Valor Descrição WIDTH 0 Número de pixels na horizontal (largura). HEIGHT 1 Número de pixels na vertical (altura). TYPE 2 Tipo da imagem ( phbmp - 0, native -1, bmp - 2 ). PHBMP 0 Tipo de imagem phbmp (proprietário da phoebus). NATIVE 1 Número de pixels na horizontal. BITMAP 2 Tipo de imagem bitmap.
Sumário¶
Função Descrição attr Busca atributo da imagem de acordo com a constante passada. bmp2PhBmp Converte bmp em PhBmp. create Cria um Tbitmap. load Carrega uma imagem Bitmap do arquivo IMG, ou faz uma cópia profunda, caso o segundo parâmetro seja uma imagem Bitmap. save Salva uma imagem ( Bitmap, PhBuffer ou nome do arquivo que contém a imagem ) no arquivo IMG. saveExt Salva uma imagem ( Bitmap, PhBuffer ou string contendo o nome do arquivo ) no arquivo IMG.
attr¶
Tbitmap#attr(bitmap)
Parâmetros¶
bitmap - Tbitmap - Imagem bitmap.
attribute - Inteiro - Atributo à ser recuperado.
Retorno¶
Inteiro representando um width, height ou type, ou invalid em caso de parâmetros inválidos.
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; /* vide a função "create" criar um Tbitmap */ var bitmap = Tbitmap#create(32, 120, data, Tbitmap#PHBMP()); Tbitmap#attr(bitmap, Tbitmap#HEIGHT());Saída:
120
bmp2PhBmp¶
Converte bmp em PhBmp.
Tbitmap#bmp2PhBmp(stream)
Parâmetros¶
stream - StreamFile - Stream de bmp.
Retorno¶
Tbitmap
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; use url StreamFile "package://vm#stream/file.wmlsc"; var stream = StreamFile#createExt("QBMP", StreamFile#O_CREAT()); Bitmap#bmp2PhBmp(stream);Saída:
Tbitmap
create¶
Cria um Tbitmap.
Tbitmap#create(width, height, data, type)
Parametros¶
width -integer - largura do bitmap.
height -integer - altura do bitmap.
data -PhBuffer ou String - conteúdo do bitmap
type -Constante - tipo da imagem.
Retorno¶
Tbitmap
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; var data = PhBuffer.create("0x00000080C0E0F078381C0C0E8686C6C2C242428282060404000890E0C080000000F8F8F8F8F878787878F8" + "F0E0C00000F8F8F80000808080000000000000000080808080000000000000000000808080808000000000" + "F8F8F8F8008080808000000000008080808000000000808080800000000000808080C0FCFEFFFF0700F0FC" + "3E0F03010100000000000000081D7EFCF3C73FFFFFFEF800FFFFFFFFFF0078787C7F3F1F0F0000FFFFFF0F" + "07070FFFFFFFFC00F8FCFEFF8F0707078FFEFEFC0070FCFEFFCFE7E7773F1F0E0600FFFFFFFF800707078F" + "FFFFFEF800FFFFFFFF00000080FFFFFFFF0080FCFEFFFF0F07073FFFFFFFF8C08F3F7E7830000000000000" + "00000080C0F07F1F07C0FFFFFF7F008FEF8F0F0F000000008080800000000F0F0F008080800F0F0F0F0001" + "0183878F8F0F0F0703030100808183070F0F0F0F0FEF0F0600010307878F8F0F0F0F0F0703008081038707" + "0F0F0F0F07A301000F0F0F8F8783000000000003070F072301404081808282828686C2C3C3E1E170383C1E" + "0F0F07010000003F2000000000001F2424241700000000001F202020110000000000003F0000003F000000" + "00001F2020201F00000000003F00000000001F2020201F00000000009FA0A0917F0000000000003F000000" + "00192424143F00"); Tbitmap#create(32, 120, data, Tbitmap#PHBMP());Saída:
Tbitmap.
load¶
Carrega uma imagem Bitmap do arquivo IMG, ou faz uma cópia profunda, caso o segundo parâmetro seja uma imagem Bitmap.
Tbitmap#load(tbitmap, tbitmapId)
Parametros¶
tbitmap - Tbitmap - Imagem Bitmap vazia que receberá a carga/cópia.
tbitmapId - integer - Identificador da imagem.
Retorno¶
true em caso de sucesso, false caso contrário.
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; var bitmap = // vide o exemplo acima para criar um Tbitmap Tbitmap#load(bitmap, invalid);Saída:
False
save¶
Salva uma imagem ( Bitmap, PhBuffer ou nome do arquivo que contém a imagem ) no arquivo IMG.
Tbitmap#save(tbitmap, tbitmapId)
Parametros¶
tbitmap - Tbitmap - Imagem Bitmap vazia que receberá a carga/cópia.
tbitmapId - integer - Identificador da imagem ou Imagem Bitmap a ser copiada.
Retorno¶
true em caso de sucesso, false caso contrário.
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; var bitmap = // vide a função "create" criar um Tbitmap. Bitmap#save(bitmap, 3);Saída:
true
saveExt¶
Salva uma imagem ( Bitmap, PhBuffer ou string contendo o nome do arquivo ) no arquivo IMG.
Tbitmap#saveExt(from, tbitmapId, height, width, type)
Parametros¶
from - Tbitmap ou PhBuffer ou String - Imagem Bitmap, PhBuffer ou nome do arquivo que contém a imagem.
tbitmapId - integer - Identificador da imagem.
height - integer - Altura da imagem em pixels.
width - integer - Largura da imagem em pixels.
type - Constante - Tipo da imagem.
Retorno¶
true em caso de sucesso, false caso contrário.
Exemplo:
use url Tbitmap "package://libs#ui/tbitmap.wmlsc"; var data = PhBuffer.create("0x00000080C0E0F078381C0C0E8686C6C2C242428282060404000890E0C080000000F8F8F8F8F878787878F8" + "F0E0C00000F8F8F80000808080000000000000000080808080000000000000000000808080808000000000" + "F8F8F8F8008080808000000000008080808000000000808080800000000000808080C0FCFEFFFF0700F0FC" + "3E0F03010100000000000000081D7EFCF3C73FFFFFFEF800FFFFFFFFFF0078787C7F3F1F0F0000FFFFFF0F" + "07070FFFFFFFFC00F8FCFEFF8F0707078FFEFEFC0070FCFEFFCFE7E7773F1F0E0600FFFFFFFF800707078F" + "FFFFFEF800FFFFFFFF00000080FFFFFFFF0080FCFEFFFF0F07073FFFFFFFF8C08F3F7E7830000000000000" + "00000080C0F07F1F07C0FFFFFF7F008FEF8F0F0F000000008080800000000F0F0F008080800F0F0F0F0001" + "0183878F8F0F0F0703030100808183070F0F0F0F0FEF0F0600010307878F8F0F0F0F0F0703008081038707" + "0F0F0F0F07A301000F0F0F8F8783000000000003070F072301404081808282828686C2C3C3E1E170383C1E" + "0F0F07010000003F2000000000001F2424241700000000001F202020110000000000003F0000003F000000" + "00001F2020201F00000000003F00000000001F2020201F00000000009FA0A0917F0000000000003F000000" + "00192424143F00"); Tbitmap#saveExt(data, 1, 32, 120, Tbitmap#PHBMP());Saída:
true


